LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15116515953

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md
View File

@@ -25,10 +25,10 @@ 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**](#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
@@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Access Model Metadata Attribute
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)
@@ -88,7 +88,7 @@ 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 Model Metadata Attribute
# Get access model metadata attribute
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -115,7 +115,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Access Model Metadata Value
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)
@@ -162,7 +162,7 @@ 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 Model Metadata Value
# Get access model metadata value
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -189,7 +189,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Access Model Metadata Attributes
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)
@@ -234,7 +234,7 @@ 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
# List access model metadata attributes
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -262,7 +262,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Access Model Metadata Values
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)
@@ -307,7 +307,7 @@ 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 Access Model Metadata Values
# List access model metadata values
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md
View File

@@ -49,18 +49,18 @@ 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) | **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
Create access profile
Create an access profile.
A user with `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.
@@ -190,7 +190,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessProfile |
try:
# Create Access Profile
# Create access profile
new_access_profile = AccessProfile.from_json(access_profile)
results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile)
# Below is a request that includes all optional parameters
@@ -206,7 +206,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-access-profile
Delete the specified 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.
@@ -251,7 +251,7 @@ 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
# Delete the specified access profile
AccessProfilesApi(api_client).delete_access_profile(id=id)
# Below is a request that includes all optional parameters
@@ -265,7 +265,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-access-profiles-in-bulk
Delete Access Profile(s)
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.
@@ -316,7 +316,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessProfileBulkDeleteRequest |
try:
# Delete Access Profile(s)
# Delete access profile(s)
new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request)
results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request)
# Below is a request that includes all optional parameters
@@ -332,7 +332,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-profile
Get an 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)
@@ -374,7 +374,7 @@ 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
# Get an access profile
results = AccessProfilesApi(api_client).get_access_profile(id=id)
# Below is a request that includes all optional parameters
@@ -390,7 +390,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-profile-entitlements
List Access Profile's 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.
@@ -444,7 +444,7 @@ with ApiClient(configuration) as api_client:
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
# List access profile's entitlements
results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id)
# Below is a request that includes all optional parameters
@@ -461,7 +461,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-profiles
List Access Profiles
List access profiles
Get a list of access profiles.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
@@ -518,7 +518,7 @@ with ApiClient(configuration) as api_client:
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
# List access profiles
results = AccessProfilesApi(api_client).list_access_profiles()
# Below is a request that includes all optional parameters
@@ -535,7 +535,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-access-profile
Patch a specified Access Profile
Patch a specified access profile
This API updates an existing Access Profile. The following fields are patchable:
**name**
@@ -609,7 +609,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Access Profile
# Patch a specified access profile
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -636,7 +636,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Access Profile(s) requestable field.
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**
@@ -689,7 +689,7 @@ with ApiClient(configuration) as api_client:
access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] |
try:
# Update Access Profile(s) requestable field.
# Update access profile(s) requestable field.
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner)
results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental=x_sail_point_experimental, access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner)
# Below is a request that includes all optional parameters

42
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md
View File

@@ -32,17 +32,17 @@ 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) | **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
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)
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
}''' # CommentDto | Reviewer's comment. (optional)
try:
# Approve Access Request Approval
# Approve access request approval
results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id)
# Below is a request that includes all optional parameters
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## forward-access-request
Forward Access Request Approval
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)
@@ -159,7 +159,7 @@ with ApiClient(configuration) as api_client:
}''' # ForwardApprovalDto | Information about the forwarded approval.
try:
# Forward Access Request Approval
# Forward access request approval
new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto)
results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto)
# Below is a request that includes all optional parameters
@@ -175,7 +175,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-approval-summary
Get Access Requests Approvals Number
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)
@@ -219,7 +219,7 @@ with ApiClient(configuration) as api_client:
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
# Get access requests approvals number
results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
# Below is a request that includes all optional parameters
@@ -235,7 +235,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-request-approvers
Access Request Approvers
Access request approvers
This API endpoint returns the list of approvers for the given access request id.
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
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
# Access request approvers
results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id=access_request_id)
# Below is a request that includes all optional parameters
@@ -302,7 +302,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-completed-approvals
Completed Access Request Approvals List
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)
@@ -354,7 +354,7 @@ 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-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
# Completed access request approvals list
results = AccessRequestApprovalsApi(api_client).list_completed_approvals()
# Below is a request that includes all optional parameters
@@ -371,7 +371,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-pending-approvals
Pending Access Request Approvals List
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)
@@ -423,7 +423,7 @@ 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-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
# Pending access request approvals list
results = AccessRequestApprovalsApi(api_client).list_pending_approvals()
# Below is a request that includes all optional parameters
@@ -440,7 +440,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-access-request
Reject Access Request Approval
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)
@@ -493,7 +493,7 @@ with ApiClient(configuration) as api_client:
}''' # CommentDto | Reviewer's comment.
try:
# Reject Access Request Approval
# Reject access request approval
new_comment_dto = CommentDto.from_json(comment_dto)
results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto)
# Below is a request that includes all optional parameters

54
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md
View File

@@ -30,20 +30,20 @@ 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
[**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
[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity
[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration
## approve-bulk-access-request
Bulk Approve 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)
@@ -89,7 +89,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkApproveAccessRequest |
try:
# Bulk Approve Access Request
# Bulk approve access request
new_bulk_approve_access_request = BulkApproveAccessRequest.from_json(bulk_approve_access_request)
results = AccessRequestsApi(api_client).approve_bulk_access_request(bulk_approve_access_request=new_bulk_approve_access_request)
# Below is a request that includes all optional parameters
@@ -105,7 +105,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## cancel-access-request
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.
@@ -152,7 +152,7 @@ with ApiClient(configuration) as api_client:
}''' # CancelAccessRequest |
try:
# Cancel Access Request
# Cancel access request
new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request)
results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request)
# Below is a request that includes all optional parameters
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## cancel-access-request-in-bulk
Bulk Cancel Access Request
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.
@@ -215,7 +215,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkCancelAccessRequest |
try:
# Bulk Cancel Access Request
# Bulk cancel access request
new_bulk_cancel_access_request = BulkCancelAccessRequest.from_json(bulk_cancel_access_request)
results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(bulk_cancel_access_request=new_bulk_cancel_access_request)
# Below is a request that includes all optional parameters
@@ -242,7 +242,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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.
@@ -303,7 +303,7 @@ with ApiClient(configuration) as api_client:
}''' # CloseAccessRequest |
try:
# Close Access Request
# Close access request
new_close_access_request = CloseAccessRequest.from_json(close_access_request)
results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request)
# Below is a request that includes all optional parameters
@@ -319,7 +319,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-access-request
Submit 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
@@ -577,7 +577,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequest |
try:
# Submit Access Request
# Submit access request
new_access_request = AccessRequest.from_json(access_request)
results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request)
# Below is a request that includes all optional parameters
@@ -593,7 +593,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-config
Get Access Request Configuration
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)
@@ -631,7 +631,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
# Get access request configuration
results = AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
@@ -647,7 +647,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-request-status
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.
@@ -709,7 +709,7 @@ with ApiClient(configuration) as api_client:
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
# Access request status
results = AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
@@ -726,7 +726,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-administrators-access-request-status
Access Request Status for Administrators
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
@@ -787,7 +787,7 @@ with ApiClient(configuration) as api_client:
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
# Access request status for administrators
results = AccessRequestsApi(api_client).list_administrators_access_request_status()
# Below is a request that includes all optional parameters
@@ -929,7 +929,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-access-request-config
Update Access Request Configuration
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)
@@ -1013,7 +1013,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestConfig |
try:
# Update Access Request Configuration
# Update access request configuration
new_access_request_config = AccessRequestConfig.from_json(access_request_config)
results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md
View File

@@ -48,12 +48,12 @@ 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-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
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)
@@ -96,7 +96,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id
try:
# Get an Account Activity
# Get an account activity
results = AccountActivitiesApi(api_client).get_account_activity(id=id)
# Below is a request that includes all optional parameters
@@ -112,7 +112,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-account-activities
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)
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
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
# List account activities
results = AccountActivitiesApi(api_client).list_account_activities()
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md
View File

@@ -25,7 +25,7 @@ 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**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status
## get-account-aggregation-status
@@ -40,7 +40,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
In-progress 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.
@@ -92,7 +92,7 @@ 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:
# In-progress Account Aggregation status
# In-progress account aggregation status
results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

96
docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md
View File

@@ -42,26 +42,26 @@ 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) | **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
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.
@@ -124,7 +124,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountAttributesCreate |
try:
# Create Account
# Create account
new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create)
results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create)
# Below is a request that includes all optional parameters
@@ -140,7 +140,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-account
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.
@@ -186,7 +186,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Delete Account
# Delete account
results = AccountsApi(api_client).delete_account(id=id)
# Below is a request that includes all optional parameters
@@ -213,7 +213,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Remove Account
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:
@@ -264,7 +264,7 @@ 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:
# Remove Account
# Remove account
results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -280,7 +280,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## disable-account
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)
@@ -329,7 +329,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountToggleRequest |
try:
# Disable Account
# Disable account
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
@@ -356,7 +356,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Disable IDN 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/v2024/disable-account-for-identity)
@@ -401,7 +401,7 @@ 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:
# Disable IDN Account for Identity
# Disable idn account for identity
results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -428,7 +428,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Disable IDN 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/v2024/disable-accounts-for-identities)
@@ -476,7 +476,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentitiesAccountsBulkRequest |
try:
# Disable IDN Accounts for Identities
# Disable idn accounts for identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
@@ -493,7 +493,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## enable-account
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)
@@ -542,7 +542,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountToggleRequest |
try:
# Enable Account
# Enable account
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
@@ -569,7 +569,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Enable IDN 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/v2024/enable-account-for-identity)
@@ -614,7 +614,7 @@ 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:
# Enable IDN Account for Identity
# Enable idn account for identity
results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -641,7 +641,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Enable IDN 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/v2024/enable-accounts-for-identities)
@@ -689,7 +689,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentitiesAccountsBulkRequest |
try:
# Enable IDN Accounts for Identities
# Enable idn accounts for identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
@@ -706,7 +706,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-account
Account Details
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)
@@ -749,7 +749,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Account Details
# Account details
results = AccountsApi(api_client).get_account(id=id)
# Below is a request that includes all optional parameters
@@ -765,7 +765,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-account-entitlements
Account Entitlements
Account entitlements
This API returns entitlements of the account.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements)
@@ -814,7 +814,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Account entitlements
results = AccountsApi(api_client).get_account_entitlements(id=id)
# Below is a request that includes all optional parameters
@@ -831,7 +831,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-accounts
Accounts List
Accounts list
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts)
@@ -883,7 +883,7 @@ with ApiClient(configuration) as api_client:
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
# Accounts list
results = AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
@@ -900,7 +900,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-account
Update 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.
@@ -959,7 +959,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountAttributes |
try:
# Update Account
# Update account
new_account_attributes = AccountAttributes.from_json(account_attributes)
results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes)
# Below is a request that includes all optional parameters
@@ -975,7 +975,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-reload-account
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)
@@ -1018,7 +1018,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
try:
# Reload Account
# Reload account
results = AccountsApi(api_client).submit_reload_account(id=id)
# Below is a request that includes all optional parameters
@@ -1034,7 +1034,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## unlock-account
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.
@@ -1085,7 +1085,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountUnlockRequest |
try:
# Unlock Account
# Unlock account
new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request)
results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request)
# Below is a request that includes all optional parameters
@@ -1101,7 +1101,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-account
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.
@@ -1155,7 +1155,7 @@ with ApiClient(configuration) as api_client:
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
# Update account
new_request_body = RequestBody.from_json(request_body)
results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md
View File

@@ -17,13 +17,13 @@ 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) | **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 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.
@@ -74,7 +74,7 @@ with ApiClient(configuration) as api_client:
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
# Get discovered applications for tenant
results = ApplicationDiscoveryApi(api_client).get_discovered_applications()
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-manual-discover-applications-csv-template
Download CSV Template for Discovery
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.
@@ -132,7 +132,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Download CSV Template for Discovery
# Download csv template for discovery
results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
# Below is a request that includes all optional parameters
@@ -148,7 +148,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Upload CSV to Discover Applications
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.
@@ -190,7 +190,7 @@ 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
# Upload csv to discover applications
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md
View File

@@ -19,7 +19,7 @@ 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-approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
## get-approval
@@ -106,7 +106,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Approvals
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.
@@ -156,7 +156,7 @@ with ApiClient(configuration) as api_client:
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
# Get approvals
results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md
View File

@@ -19,8 +19,8 @@ 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
[**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
@@ -28,8 +28,8 @@ Method | HTTP request | Description
[**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
[**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
@@ -204,7 +204,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete source app by ID
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)
@@ -249,7 +249,7 @@ 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:
# Delete source app by ID
# Delete source app by id
results = AppsApi(api_client).delete_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -276,7 +276,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get source app by ID
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)
@@ -322,7 +322,7 @@ 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 app by ID
# Get source app by id
results = AppsApi(api_client).get_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -907,7 +907,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch source app by ID
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.
@@ -958,7 +958,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch source app by ID
# Patch source app by id
results = AppsApi(api_client).patch_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -985,7 +985,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch user app by ID
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**
@@ -1035,7 +1035,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional)
try:
# Patch user app by ID
# Patch user app by id
results = AppsApi(api_client).patch_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md
View File

@@ -21,9 +21,9 @@ 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**](#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
@@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Auth Profile
Get auth profile
This API returns auth profile information.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config)
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
try:
# Get Auth Profile
# Get auth profile
results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental=x_sail_point_experimental, id=id)
# Below is a request that includes all optional parameters
@@ -111,7 +111,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get list of Auth Profiles
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)
@@ -154,7 +154,7 @@ 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
# Get list of auth profiles
results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -182,7 +182,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch a specified Auth Profile
Patch a specified auth profile
This API updates an existing Auth Profile. The following fields are patchable:
**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type**
@@ -231,7 +231,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] |
try:
# Patch a specified Auth Profile
# Patch a specified auth profile
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AuthProfileApi(api_client).patch_profile_config(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md
View File

@@ -20,12 +20,12 @@ 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**](#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
Auth user details
Return the specified user's authentication system details.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-user)
@@ -68,7 +68,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
try:
# Auth User Details
# Auth user details
results = AuthUsersApi(api_client).get_auth_user(id=id)
# Below is a request that includes all optional parameters
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-auth-user
Auth User Update
Auth user update
Use a PATCH request to update an existing user in the authentication system.
Use this endpoint to modify these fields:
* `capabilities`
@@ -134,7 +134,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]''' # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Auth User Update
# Auth user update
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md
View File

@@ -42,15 +42,15 @@ 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) | **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
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)
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignFilterDetails |
try:
# Create Campaign Filter
# Create campaign filter
new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details)
results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details)
# Below is a request that includes all optional parameters
@@ -125,7 +125,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaign-filters
Deletes 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)
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] | A json list of IDs of campaign filters to delete.
try:
# Deletes Campaign Filters
# Deletes campaign filters
new_request_body = RequestBody.from_json(request_body)
CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -181,7 +181,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-filter-by-id
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)
@@ -224,7 +224,7 @@ 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
# Get campaign filter by id
results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-campaign-filters
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)
@@ -286,7 +286,7 @@ with ApiClient(configuration) as api_client:
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
# List campaign filters
results = CertificationCampaignFiltersApi(api_client).list_campaign_filters()
# Below is a request that includes all optional parameters
@@ -302,7 +302,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-campaign-filter
Updates a 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)
@@ -363,7 +363,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignFilterDetails | A campaign filter details with updated field values.
try:
# Updates a Campaign Filter
# Updates a campaign filter
new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details)
results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details)
# Below is a request that includes all optional parameters

126
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
View File

@@ -80,32 +80,32 @@ 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
[**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
[**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
Complete a campaign
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -162,7 +162,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
try:
# Complete a Campaign
# Complete a campaign
results = CertificationCampaignsApi(api_client).complete_campaign(id=id)
# Below is a request that includes all optional parameters
@@ -346,7 +346,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-campaign-template
Create a Campaign Template
Create a campaign template
Use this API to create a certification campaign template based on campaign.
@@ -513,7 +513,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignTemplate |
try:
# Create a Campaign Template
# Create a campaign template
new_campaign_template = CampaignTemplate.from_json(campaign_template)
results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template)
# Below is a request that includes all optional parameters
@@ -529,7 +529,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaign-template
Delete a Campaign Template
Delete a campaign template
Use this API to delete a certification campaign template by ID.
@@ -572,7 +572,7 @@ 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
# Delete a campaign template
CertificationCampaignsApi(api_client).delete_campaign_template(id=id)
# Below is a request that includes all optional parameters
@@ -586,7 +586,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaign-template-schedule
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.
@@ -629,7 +629,7 @@ 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
# Delete campaign template schedule
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -643,7 +643,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaigns
Delete Campaigns
Delete campaigns
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
@@ -689,7 +689,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignsDeleteRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
# Delete campaigns
new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request)
results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request)
# Below is a request that includes all optional parameters
@@ -705,7 +705,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-active-campaigns
List 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.
@@ -758,7 +758,7 @@ with ApiClient(configuration) as api_client:
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
# List campaigns
results = CertificationCampaignsApi(api_client).get_active_campaigns()
# Below is a request that includes all optional parameters
@@ -775,7 +775,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign
Get Campaign
Get campaign
Use this API to get information for an existing certification campaign by the campaign's ID.
@@ -821,7 +821,7 @@ 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)
try:
# Get Campaign
# Get campaign
results = CertificationCampaignsApi(api_client).get_campaign(id=id)
# Below is a request that includes all optional parameters
@@ -837,7 +837,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-reports
Get Campaign Reports
Get campaign reports
Use this API to fetch all reports for a certification campaign by campaign ID.
@@ -881,7 +881,7 @@ 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
# Get campaign reports
results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id)
# Below is a request that includes all optional parameters
@@ -898,7 +898,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-reports-config
Get Campaign Reports Configuration
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.
@@ -937,7 +937,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Campaign Reports Configuration
# Get campaign reports configuration
results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
# Below is a request that includes all optional parameters
@@ -953,7 +953,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-template
Get a Campaign Template
Get a campaign template
Use this API to fetch a certification campaign template by ID.
@@ -997,7 +997,7 @@ 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
# Get a campaign template
results = CertificationCampaignsApi(api_client).get_campaign_template(id=id)
# Below is a request that includes all optional parameters
@@ -1013,7 +1013,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-template-schedule
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.
@@ -1057,7 +1057,7 @@ 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
# Get campaign template schedule
results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -1073,7 +1073,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-templates
List 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.
@@ -1126,7 +1126,7 @@ with ApiClient(configuration) as api_client:
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
# List campaign templates
results = CertificationCampaignsApi(api_client).get_campaign_templates()
# Below is a request that includes all optional parameters
@@ -1143,7 +1143,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## move
Reassign Certifications
Reassign certifications
This API reassigns the specified certifications from one identity to another.
@@ -1197,7 +1197,7 @@ with ApiClient(configuration) as api_client:
}''' # AdminReviewReassign |
try:
# Reassign Certifications
# Reassign certifications
new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign)
results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign)
# Below is a request that includes all optional parameters
@@ -1213,7 +1213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-campaign-template
Update a 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.
@@ -1260,7 +1260,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
try:
# Update a Campaign Template
# Update a campaign template
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1276,7 +1276,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-campaign-reports-config
Set Campaign Reports Configuration
Set campaign reports configuration
Use this API to overwrite the configuration for campaign reports.
@@ -1321,7 +1321,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignReportsConfig | Campaign report configuration.
try:
# Set Campaign Reports Configuration
# Set campaign reports configuration
new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config)
results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config)
# Below is a request that includes all optional parameters
@@ -1337,7 +1337,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-campaign-template-schedule
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.
@@ -1402,7 +1402,7 @@ with ApiClient(configuration) as api_client:
}''' # Schedule | (optional)
try:
# Set Campaign Template Schedule
# Set campaign template schedule
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -1416,7 +1416,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-campaign
Activate a 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.
@@ -1464,7 +1464,7 @@ with ApiClient(configuration) as api_client:
}''' # 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
# Activate a campaign
results = CertificationCampaignsApi(api_client).start_campaign(id=id)
# Below is a request that includes all optional parameters
@@ -1480,7 +1480,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-campaign-remediation-scan
Run Campaign Remediation Scan
Run campaign remediation scan
Use this API to run a remediation scan task for a certification campaign.
@@ -1523,7 +1523,7 @@ 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
# Run campaign remediation scan
results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id)
# Below is a request that includes all optional parameters
@@ -1539,7 +1539,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-campaign-report
Run Campaign Report
Run campaign report
Use this API to run a report for a certification campaign.
@@ -1585,7 +1585,7 @@ with ApiClient(configuration) as api_client:
type = sailpoint.v2024.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run.
try:
# Run Campaign Report
# Run campaign report
results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type)
# Below is a request that includes all optional parameters
@@ -1601,7 +1601,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-generate-campaign-template
Generate a Campaign from 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
@@ -1654,7 +1654,7 @@ 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
# Generate a campaign from template
results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id)
# Below is a request that includes all optional parameters
@@ -1670,7 +1670,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-campaign
Update a 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.
@@ -1717,7 +1717,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
try:
# Update a Campaign
# Update a campaign
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md
View File

@@ -29,14 +29,14 @@ 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**](#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
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)
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
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
# Access summaries
results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type)
# Below is a request that includes all optional parameters
@@ -108,7 +108,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-decision-summary
Summary of Certification Decisions
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)
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
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
# Summary of certification decisions
results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id)
# Below is a request that includes all optional parameters
@@ -169,7 +169,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-summaries
Identity Summaries for Campaign Certification
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)
@@ -222,7 +222,7 @@ with ApiClient(configuration) as api_client:
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
# Identity summaries for campaign certification
results = CertificationSummariesApi(api_client).get_identity_summaries(id=id)
# Below is a request that includes all optional parameters
@@ -239,7 +239,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-summary
Summary for Identity
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)
@@ -284,7 +284,7 @@ with ApiClient(configuration) as api_client:
identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID
try:
# Summary for Identity
# Summary for identity
results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id)
# Below is a request that includes all optional parameters

66
docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md
View File

@@ -38,21 +38,21 @@ 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**](#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
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)
@@ -95,7 +95,7 @@ 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
# Certification task by id
results = CertificationsApi(api_client).get_certification_task(id=id)
# Below is a request that includes all optional parameters
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-certification
Identity Certification by ID
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)
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id
try:
# Identity Certification by ID
# Identity certification by id
results = CertificationsApi(api_client).get_identity_certification(id=id)
# Below is a request that includes all optional parameters
@@ -170,7 +170,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-certification-item-permissions
Permissions for Entitlement Certification Item
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)
@@ -223,7 +223,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Permissions for entitlement certification item
results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id)
# Below is a request that includes all optional parameters
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-pending-certification-tasks
List of 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)
@@ -291,7 +291,7 @@ with ApiClient(configuration) as api_client:
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
# List of pending certification tasks
results = CertificationsApi(api_client).get_pending_certification_tasks()
# Below is a request that includes all optional parameters
@@ -308,7 +308,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-certification-reviewers
List of Reviewers for certification
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)
@@ -361,7 +361,7 @@ with ApiClient(configuration) as api_client:
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
# List of reviewers for certification
results = CertificationsApi(api_client).list_certification_reviewers(id=id)
# Below is a request that includes all optional parameters
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-access-review-items
List of 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)
@@ -437,7 +437,7 @@ with ApiClient(configuration) as api_client:
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
# List of access review items
results = CertificationsApi(api_client).list_identity_access_review_items(id=id)
# Below is a request that includes all optional parameters
@@ -454,7 +454,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-certifications
List Identity Campaign 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)
@@ -506,7 +506,7 @@ with ApiClient(configuration) as api_client:
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
# List identity campaign certifications
results = CertificationsApi(api_client).list_identity_certifications()
# Below is a request that includes all optional parameters
@@ -523,7 +523,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## make-identity-decision
Decide on a Certification Item
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)
@@ -569,7 +569,7 @@ with ApiClient(configuration) as api_client:
review_decision = '''[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]''' # List[ReviewDecision] | A non-empty array of decisions to be made.
try:
# Decide on a Certification Item
# Decide on a certification item
new_review_decision = ReviewDecision.from_json(review_decision)
results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision)
# Below is a request that includes all optional parameters
@@ -585,7 +585,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reassign-identity-certifications
Reassign Identities or Items
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)
@@ -641,7 +641,7 @@ with ApiClient(configuration) as api_client:
}''' # ReviewReassign |
try:
# Reassign Identities or Items
# Reassign identities or items
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters
@@ -657,7 +657,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## sign-off-identity-certification
Finalize Identity Certification Decisions
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)
@@ -700,7 +700,7 @@ 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
# Finalize identity certification decisions
results = CertificationsApi(api_client).sign_off_identity_certification(id=id)
# Below is a request that includes all optional parameters
@@ -716,7 +716,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-reassign-certs-async
Reassign Certifications Asynchronously
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.
@@ -777,7 +777,7 @@ with ApiClient(configuration) as api_client:
}''' # ReviewReassign |
try:
# Reassign Certifications Asynchronously
# Reassign certifications asynchronously
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters

84
docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md
View File

@@ -26,30 +26,30 @@ 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-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-scheduled-action**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create Scheduled Action
[**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
[**create-scheduled-action**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create scheduled action
[**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-scheduled-action**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action
[**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
[**delete-scheduled-action**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete scheduled action
[**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-scheduled-actions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List Scheduled Actions
[**list-uploaded-configurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**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-scheduled-actions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List scheduled actions
[**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
[**update-scheduled-action**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action
[**update-scheduled-action**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update scheduled action
## create-deploy
Create a 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)
@@ -94,7 +94,7 @@ with ApiClient(configuration) as api_client:
}''' # DeployRequest | The deploy request body.
try:
# Create a Deploy
# Create a deploy
new_deploy_request = DeployRequest.from_json(deploy_request)
results = ConfigurationHubApi(api_client).create_deploy(deploy_request=new_deploy_request)
# Below is a request that includes all optional parameters
@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-scheduled-action
Create Scheduled Action
Create scheduled action
This API creates a new scheduled action for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-action)
@@ -325,7 +325,7 @@ with ApiClient(configuration) as api_client:
}''' # ScheduledActionPayload | The scheduled action creation request body.
try:
# Create Scheduled Action
# Create scheduled action
new_scheduled_action_payload = ScheduledActionPayload.from_json(scheduled_action_payload)
results = ConfigurationHubApi(api_client).create_scheduled_action(scheduled_action_payload=new_scheduled_action_payload)
# Below is a request that includes all optional parameters
@@ -341,7 +341,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-uploaded-configuration
Upload a 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.
@@ -389,7 +389,7 @@ with ApiClient(configuration) as api_client:
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
# Upload a configuration
results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name)
# Below is a request that includes all optional parameters
@@ -405,7 +405,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-backup
Delete a Backup
Delete a backup
This API deletes an existing backup for the current tenant.
On success, this endpoint will return an empty response.
@@ -451,7 +451,7 @@ 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
# Delete a backup
ConfigurationHubApi(api_client).delete_backup(id=id)
# Below is a request that includes all optional parameters
@@ -586,7 +586,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-scheduled-action
Delete Scheduled Action
Delete scheduled action
This API deletes an existing scheduled action.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-action)
@@ -628,7 +628,7 @@ with ApiClient(configuration) as api_client:
scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action.
try:
# Delete Scheduled Action
# Delete scheduled action
ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id=scheduled_action_id)
# Below is a request that includes all optional parameters
@@ -642,7 +642,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-uploaded-configuration
Delete an Uploaded Configuration
Delete an uploaded configuration
This API deletes an uploaded configuration based on Id.
On success, this endpoint will return an empty response.
@@ -688,7 +688,7 @@ 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
# Delete an uploaded configuration
ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
@@ -702,7 +702,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-deploy
Get a 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)
@@ -745,7 +745,7 @@ 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
# Get a deploy
results = ConfigurationHubApi(api_client).get_deploy(id=id)
# Below is a request that includes all optional parameters
@@ -824,7 +824,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-uploaded-configuration
Get an 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)
@@ -867,7 +867,7 @@ 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
# Get an uploaded configuration
results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
@@ -883,7 +883,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-backups
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)
@@ -925,7 +925,7 @@ 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
# List backups
results = ConfigurationHubApi(api_client).list_backups()
# Below is a request that includes all optional parameters
@@ -942,7 +942,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-deploys
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)
@@ -980,7 +980,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Deploys
# List deploys
results = ConfigurationHubApi(api_client).list_deploys()
# Below is a request that includes all optional parameters
@@ -996,7 +996,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-drafts
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)
@@ -1038,7 +1038,7 @@ 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
# List drafts
results = ConfigurationHubApi(api_client).list_drafts()
# Below is a request that includes all optional parameters
@@ -1055,7 +1055,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-scheduled-actions
List Scheduled Actions
List scheduled actions
This API gets a list of existing scheduled actions for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-actions)
@@ -1093,7 +1093,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Scheduled Actions
# List scheduled actions
results = ConfigurationHubApi(api_client).list_scheduled_actions()
# Below is a request that includes all optional parameters
@@ -1110,7 +1110,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-uploaded-configurations
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)
@@ -1153,7 +1153,7 @@ 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
# List uploaded configurations
results = ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters
@@ -1248,7 +1248,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-scheduled-action
Update Scheduled Action
Update scheduled action
This API updates an existing scheduled action using JSON Patch format.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-action)
@@ -1304,7 +1304,7 @@ with ApiClient(configuration) as api_client:
}''' # JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action.
try:
# Update Scheduled Action
# Update scheduled action
new_json_patch = JsonPatch.from_json(json_patch)
results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id=scheduled_action_id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md
View File

@@ -18,16 +18,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-connector-customizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create Connector Customizer
[**create-connector-customizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create connector customizer
[**create-connector-customizer-version**](#create-connector-customizer-version) | **POST** `/connector-customizers/{id}/versions` | Creates a connector customizer version
[**delete-connector-customizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete Connector Customizer
[**delete-connector-customizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete connector customizer
[**get-connector-customizer**](#get-connector-customizer) | **GET** `/connector-customizers/{id}` | Get connector customizer
[**list-connector-customizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List All Connector Customizers
[**put-connector-customizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update Connector Customizer
[**list-connector-customizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List all connector customizers
[**put-connector-customizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update connector customizer
## create-connector-customizer
Create Connector Customizer
Create connector customizer
Create a connector customizer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-customizer)
@@ -72,7 +72,7 @@ with ApiClient(configuration) as api_client:
}''' # ConnectorCustomizerCreateRequest | Connector customizer to create.
try:
# Create Connector Customizer
# Create connector customizer
new_connector_customizer_create_request = ConnectorCustomizerCreateRequest.from_json(connector_customizer_create_request)
results = ConnectorCustomizersApi(api_client).create_connector_customizer(connector_customizer_create_request=new_connector_customizer_create_request)
# Below is a request that includes all optional parameters
@@ -147,7 +147,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-connector-customizer
Delete Connector Customizer
Delete connector customizer
Delete the connector customizer for the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-customizer)
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to delete. # str | ID of the connector customizer to delete.
try:
# Delete Connector Customizer
# Delete connector customizer
ConnectorCustomizersApi(api_client).delete_connector_customizer(id=id)
# Below is a request that includes all optional parameters
@@ -262,7 +262,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-connector-customizers
List All Connector Customizers
List all connector customizers
List all connector customizers.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connector-customizers)
@@ -306,7 +306,7 @@ 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)
try:
# List All Connector Customizers
# List all connector customizers
results = ConnectorCustomizersApi(api_client).list_connector_customizers()
# Below is a request that includes all optional parameters
@@ -323,7 +323,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-customizer
Update Connector Customizer
Update connector customizer
Update an existing connector customizer 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-customizer)
@@ -371,7 +371,7 @@ with ApiClient(configuration) as api_client:
}''' # ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional)
try:
# Update Connector Customizer
# Update connector customizer
results = ConnectorCustomizersApi(api_client).put_connector_customizer(id=id)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md
View File

@@ -22,16 +22,16 @@ 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**](#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
Create Connector Rule
Create connector rule
Create a connector rule from the available types.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-rule)
@@ -99,7 +99,7 @@ with ApiClient(configuration) as api_client:
}''' # ConnectorRuleCreateRequest | Connector rule to create.
try:
# Create Connector Rule
# Create connector rule
new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request)
results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request)
# Below is a request that includes all optional parameters
@@ -115,7 +115,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-connector-rule
Delete Connector Rule
Delete connector rule
Delete the connector rule for the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-rule)
@@ -157,7 +157,7 @@ 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 Connector Rule
# Delete connector rule
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id)
# Below is a request that includes all optional parameters
@@ -171,7 +171,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-rule
Get Connector Rule
Get connector rule
Get a connector rule by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule)
@@ -214,7 +214,7 @@ with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get.
try:
# Get Connector Rule
# Get connector rule
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id)
# Below is a request that includes all optional parameters
@@ -230,7 +230,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-rule-list
List Connector Rules
List connector rules
List existing connector rules.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule-list)
@@ -276,7 +276,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# List connector rules
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list()
# Below is a request that includes all optional parameters
@@ -293,7 +293,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-rule
Update Connector Rule
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)
@@ -365,7 +365,7 @@ with ApiClient(configuration) as api_client:
}''' # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional)
try:
# Update Connector Rule
# Update connector rule
results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id)
# Below is a request that includes all optional parameters
@@ -381,7 +381,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-connector-rule
Validate Connector Rule
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)
@@ -427,7 +427,7 @@ with ApiClient(configuration) as api_client:
}''' # SourceCode | Code to validate.
try:
# Validate Connector Rule
# Validate connector rule
new_source_code = SourceCode.from_json(source_code)
results = ConnectorRuleManagementApi(api_client).test_connector_rule(source_code=new_source_code)
# Below is a request that includes all optional parameters

78
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md
View File

@@ -29,23 +29,23 @@ 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) | **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
Create custom connector.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector)
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
}''' # V3CreateConnectorDto |
try:
# Create Custom Connector
# Create custom connector
new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto)
results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto)
# Below is a request that includes all optional parameters
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-custom-connector
Delete Connector by Script Name
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)
@@ -153,7 +153,7 @@ 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
# Delete connector by script name
ConnectorsApi(api_client).delete_custom_connector(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector
Get Connector by Script Name
Get connector by script name
Fetches a connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector)
@@ -212,7 +212,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector by script name
results = ConnectorsApi(api_client).get_connector(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -228,7 +228,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-correlation-config
Get Connector Correlation Configuration
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)
@@ -270,7 +270,7 @@ 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
# Get connector correlation configuration
results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -286,7 +286,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## 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/v2024/get-connector-list)
@@ -337,7 +337,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector list
results = ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
@@ -354,7 +354,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-source-config
Get Connector Source Configuration
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)
@@ -396,7 +396,7 @@ 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
# Get connector source configuration
results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -412,7 +412,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-source-template
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)
@@ -454,7 +454,7 @@ 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
# Get connector source template
results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -470,7 +470,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-translations
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)
@@ -514,7 +514,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector translations
results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
@@ -530,7 +530,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-correlation-config
Update Connector Correlation Configuration
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)
@@ -575,7 +575,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file
try:
# Update Connector Correlation Configuration
# Update connector correlation configuration
results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -591,7 +591,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-source-config
Update Connector Source Configuration
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)
@@ -636,7 +636,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
try:
# Update Connector Source Configuration
# Update connector source configuration
results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -652,7 +652,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-source-template
Update 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)
@@ -697,7 +697,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
try:
# Update Connector Source Template
# Update connector source template
results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -713,7 +713,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-translations
Update 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)
@@ -758,7 +758,7 @@ with ApiClient(configuration) as api_client:
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
# Update connector translations
results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
@@ -774,7 +774,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-connector
Update Connector by Script Name
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:
@@ -832,7 +832,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations
try:
# Update Connector by Script Name
# Update connector by script name
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md
View File

@@ -24,15 +24,15 @@ 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-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-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.
[**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.
@@ -213,7 +213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-form-definition-dynamic-schema
Generate JSON Schema dynamically.
Generate json schema dynamically.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema)
@@ -265,7 +265,7 @@ with ApiClient(configuration) as api_client:
}''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional)
try:
# Generate JSON Schema dynamically.
# Generate json schema dynamically.
results = CustomFormsApi(api_client).create_form_definition_dynamic_schema()
# Below is a request that includes all optional parameters
@@ -547,7 +547,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-file-from-s3
Download definition file by fileId.
Download definition file by fileid.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3)
@@ -592,7 +592,7 @@ with ApiClient(configuration) as api_client:
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.
# Download definition file by fileid.
results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id)
# Below is a request that includes all optional parameters
@@ -726,7 +726,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-form-instance-file
Download instance file by fileId.
Download instance file by fileid.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file)
@@ -771,7 +771,7 @@ with ApiClient(configuration) as api_client:
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.
# Download instance file by fileid.
results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md
View File

@@ -26,9 +26,9 @@ 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**](#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
@@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create Custom Password Instructions
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)
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
}''' # CustomPasswordInstruction |
try:
# Create Custom Password Instructions
# Create custom password instructions
new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction)
results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental=x_sail_point_experimental, custom_password_instruction=new_custom_password_instruction)
# Below is a request that includes all optional parameters
@@ -117,7 +117,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Custom Password Instructions by page ID
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)
@@ -162,7 +162,7 @@ with ApiClient(configuration) as api_client:
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
# Delete custom password instructions by page id
CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -187,7 +187,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Custom Password Instructions by Page ID
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)
@@ -233,7 +233,7 @@ with ApiClient(configuration) as api_client:
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
# Get custom password instructions by page id
results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md
View File

@@ -17,18 +17,18 @@ 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-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
Create segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
@@ -71,7 +71,7 @@ with ApiClient(configuration) as api_client:
data_segment = '''sailpoint.v2024.DataSegment()''' # DataSegment |
try:
# Create Segment
# Create segment
new_data_segment = DataSegment.from_json(data_segment)
results = DataSegmentationApi(api_client).create_data_segment(data_segment=new_data_segment)
# Below is a request that includes all optional parameters
@@ -98,7 +98,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Segment by ID
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)
@@ -145,7 +145,7 @@ with ApiClient(configuration) as api_client:
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
# Delete segment by id
DataSegmentationApi(api_client).delete_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -170,7 +170,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Segment by ID
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)
@@ -216,7 +216,7 @@ 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 Segment by ID
# Get segment by id
results = DataSegmentationApi(api_client).get_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -243,7 +243,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get SegmentMembership by Identity ID
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)
@@ -288,7 +288,7 @@ 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 SegmentMembership by Identity ID
# Get segmentmembership by identity id
results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -315,7 +315,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Is Segmentation enabled by Identity
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)
@@ -360,7 +360,7 @@ 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:
# Is Segmentation enabled by Identity
# Is segmentation enabled by identity
results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -387,7 +387,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Segments
Get segments
This API returns the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-data-segments)
@@ -445,7 +445,7 @@ with ApiClient(configuration) as api_client:
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
# Get segments
results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -473,7 +473,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Segment
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)
@@ -521,7 +521,7 @@ with ApiClient(configuration) as api_client:
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
# Update segment
new_request_body = RequestBody.from_json(request_body)
results = DataSegmentationApi(api_client).patch_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -548,7 +548,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Publish segment by ID
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)
@@ -595,7 +595,7 @@ with ApiClient(configuration) as api_client:
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
# Publish segment by id
new_request_body = RequestBody.from_json(request_body)
DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md
View File

@@ -16,18 +16,18 @@ 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-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
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.
@@ -160,7 +160,7 @@ with ApiClient(configuration) as api_client:
}''' # Dimension |
try:
# Create a Dimension
# Create a dimension
new_dimension = Dimension.from_json(dimension)
results = DimensionsApi(api_client).create_dimension(role_id=role_id, dimension=new_dimension)
# Below is a request that includes all optional parameters
@@ -176,7 +176,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-bulk-dimensions
Delete Dimension(s)
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.
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
}''' # DimensionBulkDeleteRequest |
try:
# Delete Dimension(s)
# Delete dimension(s)
new_dimension_bulk_delete_request = DimensionBulkDeleteRequest.from_json(dimension_bulk_delete_request)
results = DimensionsApi(api_client).delete_bulk_dimensions(role_id=role_id, dimension_bulk_delete_request=new_dimension_bulk_delete_request)
# Below is a request that includes all optional parameters
@@ -242,7 +242,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-dimension
Delete a 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.
@@ -286,7 +286,7 @@ with ApiClient(configuration) as api_client:
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
try:
# Delete a Dimension
# Delete a dimension
DimensionsApi(api_client).delete_dimension(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
@@ -300,7 +300,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-dimension
Get a Dimension under Role.
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.
@@ -346,7 +346,7 @@ with ApiClient(configuration) as api_client:
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
try:
# Get a Dimension under Role.
# Get a dimension under role.
results = DimensionsApi(api_client).get_dimension(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
@@ -362,7 +362,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-dimension-entitlements
List Dimension's 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.
@@ -418,7 +418,7 @@ with ApiClient(configuration) as api_client:
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
# List dimension's entitlements
results = DimensionsApi(api_client).get_dimension_entitlements(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
@@ -435,7 +435,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-dimension-access-profiles
List Dimension's 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.
@@ -492,7 +492,7 @@ with ApiClient(configuration) as api_client:
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
# List dimension's access profiles
results = DimensionsApi(api_client).list_dimension_access_profiles(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
@@ -509,7 +509,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-dimensions
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.
@@ -565,7 +565,7 @@ with ApiClient(configuration) as api_client:
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
# List dimensions
results = DimensionsApi(api_client).list_dimensions(role_id=role_id)
# Below is a request that includes all optional parameters
@@ -582,7 +582,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-dimension
Patch a specified 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.
@@ -633,7 +633,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Dimension
# Patch a specified dimension
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = DimensionsApi(api_client).patch_dimension(role_id=role_id, dimension_id=dimension_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md
View File

@@ -67,14 +67,14 @@ 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
[**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
[**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
@@ -312,7 +312,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/get-entitlement-request-config)
@@ -358,7 +358,7 @@ 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 Entitlement Request Config
# Get entitlement request config
results = EntitlementsApi(api_client).get_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -388,7 +388,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Aggregate Entitlements
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.
@@ -439,7 +439,7 @@ with ApiClient(configuration) as api_client:
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
# Aggregate entitlements
results = EntitlementsApi(api_client).import_entitlements_by_source(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -807,7 +807,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Replace 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/v2024/put-entitlement-request-config)
@@ -877,7 +877,7 @@ with ApiClient(configuration) as api_client:
}''' # EntitlementRequestConfig |
try:
# Replace Entitlement Request Config
# Replace entitlement request config
new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config)
results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental, entitlement_request_config=new_entitlement_request_config)
# Below is a request that includes all optional parameters
@@ -904,7 +904,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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 [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`.
@@ -950,7 +950,7 @@ 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:
# Reset Source Entitlements
# Reset source entitlements
results = EntitlementsApi(api_client).reset_source_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md
View File

@@ -19,14 +19,14 @@ 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-lockout-config**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout 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
[**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
[**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
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-auth-org-lockout-config
Get Auth Org Lockout Configuration.
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/v2024/get-auth-org-lockout-config)
@@ -132,7 +132,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Auth Org Lockout Configuration.
# Get auth org lockout configuration.
results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config()
# Below is a request that includes all optional parameters
@@ -203,7 +203,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-auth-org-service-provider-config
Get Service Provider Configuration.
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/v2024/get-auth-org-service-provider-config)
@@ -242,7 +242,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Service Provider Configuration.
# Get service provider configuration.
results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config()
# Below is a request that includes all optional parameters
@@ -258,7 +258,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-auth-org-session-config
Get Auth Org Session Configuration.
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/v2024/get-auth-org-session-config)
@@ -297,7 +297,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Auth Org Session Configuration.
# Get auth org session configuration.
results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config()
# Below is a request that includes all optional parameters
@@ -313,7 +313,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-auth-org-lockout-config
Update Auth Org Lockout Configuration
Update auth org lockout configuration
This API updates an existing lockout configuration for an org using PATCH
@@ -358,7 +358,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
try:
# Update Auth Org Lockout Configuration
# Update auth org lockout configuration
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -435,7 +435,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-auth-org-service-provider-config
Update Service Provider Configuration
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/v2024/patch-auth-org-service-provider-config)
@@ -479,7 +479,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
try:
# Update Service Provider Configuration
# Update service provider configuration
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -495,7 +495,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-auth-org-session-config
Update Auth Org Session Configuration
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/v2024/patch-auth-org-session-config)
@@ -539,7 +539,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
try:
# Update Auth Org Session Configuration
# Update auth org session configuration
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

60
docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md
View File

@@ -20,16 +20,16 @@ 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**](#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
@@ -44,7 +44,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create a new Governance Group.
Create a new governance group.
This API creates a new Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup)
@@ -104,7 +104,7 @@ with ApiClient(configuration) as api_client:
}''' # WorkgroupDto |
try:
# Create a new Governance Group.
# Create a new governance group.
new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto)
results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental=x_sail_point_experimental, workgroup_dto=new_workgroup_dto)
# Below is a request that includes all optional parameters
@@ -131,7 +131,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete a Governance Group
Delete a governance group
This API deletes a Governance Group by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup)
@@ -175,7 +175,7 @@ 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:
# Delete a Governance Group
# Delete a governance group
GovernanceGroupsApi(api_client).delete_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -200,7 +200,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Remove members from Governance Group
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.**
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
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
# Remove members from governance group
new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity)
results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity)
# Below is a request that includes all optional parameters
@@ -279,7 +279,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Governance Group(s)
Delete governance group(s)
This API initiates a bulk deletion of one or more Governance Groups.
@@ -338,7 +338,7 @@ with ApiClient(configuration) as api_client:
}''' # WorkgroupBulkDeleteRequest |
try:
# Delete Governance Group(s)
# Delete governance group(s)
new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request)
results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental=x_sail_point_experimental, workgroup_bulk_delete_request=new_workgroup_bulk_delete_request)
# Below is a request that includes all optional parameters
@@ -366,7 +366,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Governance Group by Id
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)
@@ -411,7 +411,7 @@ 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 Governance Group by Id
# Get governance group by id
results = GovernanceGroupsApi(api_client).get_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -438,7 +438,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List connections for Governance Group
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)
@@ -491,7 +491,7 @@ with ApiClient(configuration) as api_client:
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
# List connections for governance group
results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -519,7 +519,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Governance Group Members
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)
@@ -572,7 +572,7 @@ with ApiClient(configuration) as api_client:
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
# List governance group members
results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -600,7 +600,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Governance Groups
List governance groups
This API returns list of Governance Groups
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups)
@@ -653,7 +653,7 @@ with ApiClient(configuration) as api_client:
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
# List governance groups
results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -681,7 +681,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch a Governance Group
Patch a governance group
This API updates an existing governance group by ID. The following fields and objects are patchable:
* name
* description
@@ -732,7 +732,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch a Governance Group
# Patch a governance group
results = GovernanceGroupsApi(api_client).patch_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -759,7 +759,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Add members to Governance Group
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.**
@@ -811,7 +811,7 @@ with ApiClient(configuration) as api_client:
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
# Add members to governance group
new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity)
results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity)
# Below is a request that includes all optional parameters

60
docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md
View File

@@ -15,16 +15,16 @@ 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` | Ignore Access Request Recommendation
[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark 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` | Bulk Mark Viewed Access Request Recommendations
[**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 Ignored Access Request Recommendations
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List 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**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation
[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark 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` | Bulk mark viewed access request recommendations
[**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 ignored access request recommendations
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List 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
@@ -39,7 +39,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Ignore Access Request Recommendation
Ignore access request recommendation
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)
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity.
try:
# Ignore Access Request Recommendation
# Ignore access request recommendation
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -118,7 +118,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Accept Access Request Recommendation
Accept access request recommendation
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)
@@ -170,7 +170,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity.
try:
# Accept Access Request Recommendation
# Accept access request recommendation
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -197,7 +197,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Mark Viewed Access Request Recommendations
Mark 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)
@@ -249,7 +249,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity.
try:
# Mark Viewed Access Request Recommendations
# Mark viewed access request recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -276,7 +276,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Bulk Mark Viewed Access Request Recommendations
Bulk mark viewed access request recommendations
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)
@@ -322,7 +322,7 @@ with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = '''[sailpoint.v2024.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity.
try:
# Bulk Mark Viewed Access Request Recommendations
# Bulk mark viewed access request recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -350,7 +350,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Identity 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/v2024/get-access-request-recommendations)
@@ -407,7 +407,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
try:
# Identity Access Request Recommendations
# Identity access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -435,7 +435,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Access Request Recommendations config
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)
@@ -478,7 +478,7 @@ 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
# Get access request recommendations config
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -505,7 +505,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Ignored Access Request Recommendations
List 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)
@@ -558,7 +558,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional)
try:
# List Ignored Access Request Recommendations
# List ignored access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -586,7 +586,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Accepted Access Request Recommendations
List accepted 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)
@@ -639,7 +639,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional)
try:
# List Accepted Access Request Recommendations
# List accepted access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -667,7 +667,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Viewed Access Request Recommendations
List 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)
@@ -720,7 +720,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional)
try:
# List Viewed Access Request Recommendations
# List viewed access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -748,7 +748,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Access Request Recommendations config
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)
@@ -800,7 +800,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant.
try:
# Update Access Request Recommendations config
# Update access request recommendations config
new_access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto.from_json(access_request_recommendation_config_dto)
results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_config_dto=new_access_request_recommendation_config_dto)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md
View File

@@ -15,15 +15,15 @@ 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
[**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&#39;s contibuting features
[**ignore-identity-outliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore
[**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
[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | Iai identity outliers unignore
## export-outliers-zip
@@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
IAI Identity Outliers Export
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).
@@ -85,7 +85,7 @@ 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
# Iai identity outliers export
results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -112,7 +112,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
IAI Identity Outliers Summary
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)
@@ -166,7 +166,7 @@ with ApiClient(configuration) as api_client:
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
# Iai identity outliers summary
results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -194,7 +194,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
IAI 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/v2024/get-identity-outliers)
@@ -249,7 +249,7 @@ with ApiClient(configuration) as api_client:
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
# Iai get identity outliers
results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -277,7 +277,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
IAI Identity Outliers Latest Summary
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)
@@ -323,7 +323,7 @@ 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
# Iai identity outliers latest summary
results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -514,7 +514,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
IAI Identity Outliers Ignore
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)
@@ -558,7 +558,7 @@ with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] |
try:
# IAI Identity Outliers Ignore
# Iai identity outliers ignore
new_request_body = RequestBody.from_json(request_body)
IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -672,7 +672,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
IAI Identity Outliers Unignore
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)
@@ -716,7 +716,7 @@ with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] |
try:
# IAI Identity Outliers Unignore
# Iai identity outliers unignore
new_request_body = RequestBody.from_json(request_body)
IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md
View File

@@ -15,7 +15,7 @@ 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**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list
## get-peer-group-outliers
@@ -33,7 +33,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Identity Outliers List
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)
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Identity outliers list
results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md
View File

@@ -15,7 +15,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object
[**get-recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns 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
@@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Returns Recommendation Based on Object
Returns 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)
@@ -96,7 +96,7 @@ with ApiClient(configuration) as api_client:
}''' # RecommendationRequestDto |
try:
# Returns Recommendation Based on Object
# Returns recommendation based on object
new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto)
results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental=x_sail_point_experimental, recommendation_request_dto=new_recommendation_request_dto)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md
View File

@@ -31,15 +31,15 @@ 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**](#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
[**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
[**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.
@@ -125,7 +125,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Identity Details
Identity details
This API returns a single identity using the Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity)
@@ -171,7 +171,7 @@ 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:
# Identity Details
# Identity details
results = IdentitiesApi(api_client).get_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -426,7 +426,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Identities
List identities
This API returns a list of identities.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities)
@@ -481,7 +481,7 @@ 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)
try:
# List Identities
# List identities
results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -738,7 +738,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Process a list of identityIds
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:
@@ -794,7 +794,7 @@ with ApiClient(configuration) as api_client:
}''' # ProcessIdentitiesRequest |
try:
# Process a list of identityIds
# Process a list of identityids
new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request)
results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental=x_sail_point_experimental, process_identities_request=new_process_identities_request)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md
View File

@@ -15,12 +15,12 @@ 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**](#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
@@ -35,7 +35,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create Identity Attribute
Create identity attribute
Use this API to create a new identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute)
@@ -102,7 +102,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityAttribute |
try:
# Create Identity Attribute
# Create identity attribute
new_identity_attribute = IdentityAttribute.from_json(identity_attribute)
results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters
@@ -129,7 +129,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute)
@@ -174,7 +174,7 @@ 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:
# Delete Identity Attribute
# Delete identity attribute
IdentityAttributesApi(api_client).delete_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -199,7 +199,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Bulk delete Identity Attributes
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)
@@ -247,7 +247,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityAttributeNames |
try:
# Bulk delete Identity Attributes
# Bulk delete identity attributes
new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names)
IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental=x_sail_point_experimental, identity_attribute_names=new_identity_attribute_names)
# Below is a request that includes all optional parameters
@@ -272,7 +272,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Identity Attribute
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)
@@ -318,7 +318,7 @@ 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 Identity Attribute
# Get identity attribute
results = IdentityAttributesApi(api_client).get_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -345,7 +345,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Identity Attributes
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)
@@ -396,7 +396,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# List identity attributes
results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -424,7 +424,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update 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.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute)
@@ -493,7 +493,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityAttribute |
try:
# Update Identity Attribute
# Update identity attribute
new_identity_attribute = IdentityAttribute.from_json(identity_attribute)
results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md
View File

@@ -16,14 +16,14 @@ 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
[**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-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
@@ -125,7 +125,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Gets a list of differences of specific accessType for the given identity between 2 snapshots
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)
@@ -184,7 +184,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Gets a list of differences of specific accesstype for the given identity between 2 snapshots
results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -681,7 +681,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Access Items by Identity
List access items by identity
This method retrieves a list of access item for the identity filtered by the access item type
@@ -736,7 +736,7 @@ 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)
try:
# List Access Items by Identity
# List access items by identity
results = IdentityHistoryApi(api_client).list_identity_access_items(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters

60
docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md
View File

@@ -25,21 +25,21 @@ 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
[**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
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile
## create-identity-profile
Create Identity Profile
Create identity profile
Creates an identity profile.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile)
@@ -129,7 +129,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityProfile |
try:
# Create Identity Profile
# Create identity profile
new_identity_profile = IdentityProfile.from_json(identity_profile)
results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile)
# Below is a request that includes all optional parameters
@@ -145,7 +145,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-profile
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.
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
try:
# Delete Identity Profile
# Delete identity profile
results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -205,7 +205,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-profiles
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.
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] | Identity Profile bulk delete request body.
try:
# Delete Identity Profiles
# Delete identity profiles
new_request_body = RequestBody.from_json(request_body)
results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -267,7 +267,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-identity-profiles
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)
@@ -317,7 +317,7 @@ with ApiClient(configuration) as api_client:
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
# Export identity profiles
results = IdentityProfilesApi(api_client).export_identity_profiles()
# Below is a request that includes all optional parameters
@@ -345,7 +345,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Generate Identity Profile Preview
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)
@@ -417,7 +417,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityPreviewRequest | Identity Preview request body.
try:
# Generate Identity Profile Preview
# Generate identity profile preview
new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request)
results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request)
# Below is a request that includes all optional parameters
@@ -433,7 +433,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-default-identity-attribute-config
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)
@@ -476,7 +476,7 @@ 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
# Get default identity attribute config
results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -492,7 +492,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-profile
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)
@@ -535,7 +535,7 @@ 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
# Get identity profile
results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -551,7 +551,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-identity-profiles
Import Identity Profiles
Import identity profiles
This imports previously exported identity profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-identity-profiles)
@@ -594,7 +594,7 @@ with ApiClient(configuration) as api_client:
identity_profile_exported_object = '''[sailpoint.v2024.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles.
try:
# Import Identity Profiles
# Import identity profiles
new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object)
results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object)
# Below is a request that includes all optional parameters
@@ -610,7 +610,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-profiles
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)
@@ -660,7 +660,7 @@ with ApiClient(configuration) as api_client:
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
# List identity profiles
results = IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
@@ -739,7 +739,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-identity-profile
Update Identity Profile
Update identity profile
Update a specified identity profile with this PATCH request.
You cannot update these fields:
@@ -793,7 +793,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Identity Profile
# Update identity profile
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md
View File

@@ -53,16 +53,16 @@ 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) | **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
Create lifecycle state
Use this endpoint to create a lifecycle state.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-lifecycle-state)
@@ -130,7 +130,7 @@ with ApiClient(configuration) as api_client:
}''' # LifecycleState | Lifecycle state to be created.
try:
# Create Lifecycle State
# Create lifecycle state
new_lifecycle_state = LifecycleState.from_json(lifecycle_state)
results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state)
# Below is a request that includes all optional parameters
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-lifecycle-state
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)
@@ -191,7 +191,7 @@ with ApiClient(configuration) as api_client:
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
try:
# Delete Lifecycle State
# Delete lifecycle state
results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
@@ -207,7 +207,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-lifecycle-state
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)
@@ -252,7 +252,7 @@ with ApiClient(configuration) as api_client:
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
try:
# Get Lifecycle State
# Get lifecycle state
results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
@@ -268,7 +268,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-lifecycle-states
Lists LifecycleStates
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)
@@ -318,7 +318,7 @@ with ApiClient(configuration) as api_client:
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
# Lists lifecyclestates
results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -335,7 +335,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-lifecycle-state
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)
@@ -381,7 +381,7 @@ with ApiClient(configuration) as api_client:
set_lifecycle_state_request = '''sailpoint.v2024.SetLifecycleStateRequest()''' # SetLifecycleStateRequest |
try:
# Set Lifecycle State
# Set lifecycle state
new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request)
results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request)
# Below is a request that includes all optional parameters
@@ -397,7 +397,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-lifecycle-states
Update Lifecycle State
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)
@@ -445,7 +445,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
try:
# Update Lifecycle State
# Update lifecycle state
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

42
docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md
View File

@@ -15,17 +15,17 @@ 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&#39;s test 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&#39;s test configuration
## get-mfa-duo-config
Configuration of Duo MFA method
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)
@@ -63,7 +63,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Duo MFA method
# Configuration of duo mfa method
results = MFAConfigurationApi(api_client).get_mfa_duo_config()
# Below is a request that includes all optional parameters
@@ -79,7 +79,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-mfa-kba-config
Configuration of KBA MFA method
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)
@@ -121,7 +121,7 @@ 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
# Configuration of kba mfa method
results = MFAConfigurationApi(api_client).get_mfa_kba_config()
# Below is a request that includes all optional parameters
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-mfa-okta-config
Configuration of Okta MFA method
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)
@@ -176,7 +176,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Okta MFA method
# Configuration of okta mfa method
results = MFAConfigurationApi(api_client).get_mfa_okta_config()
# Below is a request that includes all optional parameters
@@ -192,7 +192,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-mfa-duo-config
Set Duo MFA configuration
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)
@@ -244,7 +244,7 @@ with ApiClient(configuration) as api_client:
}''' # MfaDuoConfig |
try:
# Set Duo MFA configuration
# Set duo mfa configuration
new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config)
results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config)
# Below is a request that includes all optional parameters
@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-mfa-okta-config
Set Okta MFA configuration
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)
@@ -308,7 +308,7 @@ with ApiClient(configuration) as api_client:
}''' # MfaOktaConfig |
try:
# Set Okta MFA configuration
# Set okta mfa configuration
new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config)
results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config)
# Below is a request that includes all optional parameters
@@ -324,7 +324,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-mfakba-config
Set MFA KBA configuration
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)
@@ -367,7 +367,7 @@ with ApiClient(configuration) as api_client:
kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] |
try:
# Set MFA KBA configuration
# Set mfa kba configuration
new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item)
results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item)
# Below is a request that includes all optional parameters
@@ -384,7 +384,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-mfa-config
MFA method's test configuration
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)
@@ -426,7 +426,7 @@ 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
# Mfa method's test configuration
results = MFAConfigurationApi(api_client).test_mfa_config(method=method)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountMappingsApi.md
View File

@@ -15,14 +15,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-machine-account-mappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings
[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete Source&#39;s Machine Account Mappings
[**list-machine-account-mappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source
[**set-machine-account-mappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source&#39;s Machine Account Mappings
[**create-machine-account-mappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create machine account mappings
[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete source&#39;s machine account mappings
[**list-machine-account-mappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine account mapping for source
[**set-machine-account-mappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update source&#39;s machine account mappings
## create-machine-account-mappings
Create Machine Account Mappings
Create machine account mappings
Creates Machine Account Mappings for both identities and accounts for a source.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -87,7 +87,7 @@ with ApiClient(configuration) as api_client:
}''' # AttributeMappings |
try:
# Create Machine Account Mappings
# Create machine account mappings
new_attribute_mappings = AttributeMappings.from_json(attribute_mappings)
results = MachineAccountMappingsApi(api_client).create_machine_account_mappings(id=id, attribute_mappings=new_attribute_mappings)
# Below is a request that includes all optional parameters
@@ -104,7 +104,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-machine-account-mappings
Delete Source's Machine Account Mappings
Delete source's machine account mappings
Use this API to remove machine account attribute mappings for a Source.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -147,7 +147,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | source ID. # str | source ID.
try:
# Delete Source's Machine Account Mappings
# Delete source's machine account mappings
MachineAccountMappingsApi(api_client).delete_machine_account_mappings(id=id)
# Below is a request that includes all optional parameters
@@ -161,7 +161,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-machine-account-mappings
Machine Account Mapping for Source
Machine account mapping for source
Retrieves Machine account mappings for a specified source using Source ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-account-mappings)
@@ -208,7 +208,7 @@ 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)
try:
# Machine Account Mapping for Source
# Machine account mapping for source
results = MachineAccountMappingsApi(api_client).list_machine_account_mappings(id=id)
# Below is a request that includes all optional parameters
@@ -225,7 +225,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-machine-account-mappings
Update Source's Machine Account Mappings
Update source's machine account mappings
Use this API to update Machine Account Attribute Mapping for a Source. 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/v2024/set-machine-account-mappings)
@@ -290,7 +290,7 @@ with ApiClient(configuration) as api_client:
}''' # AttributeMappings |
try:
# Update Source's Machine Account Mappings
# Update source's machine account mappings
new_attribute_mappings = AttributeMappings.from_json(attribute_mappings)
results = MachineAccountMappingsApi(api_client).set_machine_account_mappings(id=id, attribute_mappings=new_attribute_mappings)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md
View File

@@ -15,9 +15,9 @@ 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**](#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
@@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Machine Account Details
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)
@@ -78,7 +78,7 @@ 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:
# Machine Account Details
# Machine account details
results = MachineAccountsApi(api_client).get_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -105,7 +105,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Machine Accounts List
Machine accounts list
This returns a list of machine accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts)
@@ -159,7 +159,7 @@ with ApiClient(configuration) as api_client:
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
# Machine accounts list
results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -187,7 +187,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update a Machine Account
Update a machine account
Use this API to update machine accounts details.
@@ -236,7 +236,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes
try:
# Update a Machine Account
# Update a machine account
new_request_body = RequestBody.from_json(request_body)
results = MachineAccountsApi(api_client).update_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/MachineClassificationConfigApi.md
View File

@@ -15,13 +15,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-machine-classification-config**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete Source&#39;s Classification Config
[**get-machine-classification-config**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source
[**set-machine-classification-config**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update Source&#39;s Classification Config
[**delete-machine-classification-config**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete source&#39;s classification config
[**get-machine-classification-config**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine classification config for source
[**set-machine-classification-config**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update source&#39;s classification config
## delete-machine-classification-config
Delete Source's Classification Config
Delete source's classification config
Use this API to remove Classification Config for a Source.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -64,7 +64,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
try:
# Delete Source's Classification Config
# Delete source's classification config
MachineClassificationConfigApi(api_client).delete_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
@@ -78,7 +78,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-machine-classification-config
Machine Classification Config for Source
Machine classification config for source
This API returns a Machine Classification Config for a Source using Source ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-classification-config)
@@ -121,7 +121,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID # str | Source ID
try:
# Machine Classification Config for Source
# Machine classification config for source
results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
@@ -137,7 +137,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-machine-classification-config
Update Source's Classification Config
Update source's classification config
Use this API to update Classification Config for a Source. 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/v2024/set-machine-classification-config)
@@ -188,7 +188,7 @@ with ApiClient(configuration) as api_client:
}''' # MachineClassificationConfig |
try:
# Update Source's Classification Config
# Update source's classification config
new_machine_classification_config = MachineClassificationConfig.from_json(machine_classification_config)
results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id=id, machine_classification_config=new_machine_classification_config)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md
View File

@@ -15,11 +15,11 @@ 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
[**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
[**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
@@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create Machine Identities
Create machine identities
Use this API to create a machine identity.
The maximum supported length for the description field is 2000 characters.
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
}''' # MachineIdentity |
try:
# Create Machine Identities
# Create machine identities
new_machine_identity = MachineIdentity.from_json(machine_identity)
results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental=x_sail_point_experimental, machine_identity=new_machine_identity)
# Below is a request that includes all optional parameters
@@ -187,7 +187,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Machine Identity Details
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)
@@ -233,7 +233,7 @@ 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:
# Machine Identity Details
# Machine identity details
results = MachineIdentitiesApi(api_client).get_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -260,7 +260,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Machine Identities
List machine identities
This API returns a list of machine identities.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities)
@@ -314,7 +314,7 @@ 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)
try:
# List Machine Identities
# List machine identities
results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -342,7 +342,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update a Machine Identity
Update a machine identity
Use this API to update machine identity details.
@@ -391,7 +391,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update a Machine Identity
# Update a machine identity
new_request_body = RequestBody.from_json(request_body)
results = MachineIdentitiesApi(api_client).update_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md
View File

@@ -17,16 +17,16 @@ 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) | **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 managed client
Create a new managed client.
The API returns a result that includes the managed client ID.
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
}''' # ManagedClientRequest |
try:
# Create Managed Client
# Create managed client
new_managed_client_request = ManagedClientRequest.from_json(managed_client_request)
results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request)
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-managed-client
Delete Managed Client
Delete managed client
Delete an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-client)
@@ -132,7 +132,7 @@ with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Delete Managed Client
# Delete managed client
ManagedClientsApi(api_client).delete_managed_client(id=id)
# Below is a request that includes all optional parameters
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-client
Get Managed Client
Get managed client
Get managed client by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client)
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Get Managed Client
# Get managed client
results = ManagedClientsApi(api_client).get_managed_client(id=id)
# Below is a request that includes all optional parameters
@@ -205,7 +205,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-client-status
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)
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
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
# Get managed client status
results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type)
# Below is a request that includes all optional parameters
@@ -267,7 +267,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-clients
Get Managed Clients
Get managed clients
List managed clients.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clients)
@@ -315,7 +315,7 @@ with ApiClient(configuration) as api_client:
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
# Get managed clients
results = ManagedClientsApi(api_client).get_managed_clients()
# Below is a request that includes all optional parameters
@@ -332,7 +332,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-managed-client
Update Managed Client
Update managed client
Update an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-client)
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object.
try:
# Update Managed Client
# Update managed client
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md
View File

@@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-managed-cluster-type**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new Managed Cluster Type
[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type
[**get-managed-cluster-type**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a Managed Cluster Type
[**get-managed-cluster-types**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get Managed Cluster Types
[**update-managed-cluster-type**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a Managed Cluster Type
[**create-managed-cluster-type**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new managed cluster type
[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a managed cluster type
[**get-managed-cluster-type**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a managed cluster type
[**get-managed-cluster-types**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get managed cluster types
[**update-managed-cluster-type**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a managed cluster type
## create-managed-cluster-type
Create new Managed Cluster Type
Create new managed cluster type
Create a new Managed Cluster Type.
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
The API returns a result that includes the Managed Cluster Type ID
@@ -76,7 +76,7 @@ with ApiClient(configuration) as api_client:
}''' # ManagedClusterType |
try:
# Create new Managed Cluster Type
# Create new managed cluster type
new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type)
results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type)
# Below is a request that includes all optional parameters
@@ -92,7 +92,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-managed-cluster-type
Delete a Managed Cluster Type
Delete a managed cluster type
Delete an existing Managed Cluster Type.
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
@@ -134,7 +134,7 @@ with ApiClient(configuration) as api_client:
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
try:
# Delete a Managed Cluster Type
# Delete a managed cluster type
ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id)
# Below is a request that includes all optional parameters
@@ -148,7 +148,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-cluster-type
Get a Managed Cluster Type
Get a managed cluster type
Get a Managed Cluster Type.
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
@@ -192,7 +192,7 @@ with ApiClient(configuration) as api_client:
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
try:
# Get a Managed Cluster Type
# Get a managed cluster type
results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id)
# Below is a request that includes all optional parameters
@@ -208,7 +208,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-cluster-types
Get Managed Cluster Types
Get managed cluster types
Get a list of Managed Cluster Types.
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
@@ -260,7 +260,7 @@ 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)
try:
# Get Managed Cluster Types
# Get managed cluster types
results = ManagedClusterTypesApi(api_client).get_managed_cluster_types()
# Below is a request that includes all optional parameters
@@ -277,7 +277,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-managed-cluster-type
Update a Managed Cluster Type
Update a managed cluster type
Update an existing Managed Cluster Type.
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
@@ -334,7 +334,7 @@ with ApiClient(configuration) as api_client:
}''' # JsonPatch | The JSONPatch payload used to update the schema.
try:
# Update a Managed Cluster Type
# Update a managed cluster type
new_json_patch = JsonPatch.from_json(json_patch)
results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md
View File

@@ -17,18 +17,18 @@ 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**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster
[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
[**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**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster
[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update managed cluster
## create-managed-cluster
Create Create Managed Cluster
Create create managed cluster
Create a new Managed Cluster.
The API returns a result that includes the managed cluster ID.
@@ -80,7 +80,7 @@ with ApiClient(configuration) as api_client:
}''' # ManagedClusterRequest |
try:
# Create Create Managed Cluster
# Create create managed cluster
new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request)
results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request)
# Below is a request that includes all optional parameters
@@ -96,7 +96,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-managed-cluster
Delete Managed Cluster
Delete managed cluster
Delete an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster)
@@ -139,7 +139,7 @@ with ApiClient(configuration) as api_client:
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
# Delete managed cluster
ManagedClustersApi(api_client).delete_managed_cluster(id=id)
# Below is a request that includes all optional parameters
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-client-log-configuration
Get Managed Cluster 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)
@@ -197,7 +197,7 @@ 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
# Get managed cluster log configuration
results = ManagedClustersApi(api_client).get_client_log_configuration(id=id)
# Below is a request that includes all optional parameters
@@ -213,7 +213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-cluster
Get Managed Cluster
Get managed cluster
Get a managed cluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster)
@@ -256,7 +256,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
try:
# Get Managed Cluster
# Get managed cluster
results = ManagedClustersApi(api_client).get_managed_cluster(id=id)
# Below is a request that includes all optional parameters
@@ -272,7 +272,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-clusters
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)
@@ -320,7 +320,7 @@ with ApiClient(configuration) as api_client:
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* **name**: *eq* **type**: *eq* **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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional)
try:
# Get Managed Clusters
# Get managed clusters
results = ManagedClustersApi(api_client).get_managed_clusters()
# Below is a request that includes all optional parameters
@@ -337,7 +337,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-client-log-configuration
Update Managed Cluster 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)
@@ -383,7 +383,7 @@ with ApiClient(configuration) as api_client:
put_client_log_configuration_request = '''sailpoint.v2024.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster.
try:
# Update Managed Cluster Log Configuration
# Update managed cluster log configuration
new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request)
results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request)
# Below is a request that includes all optional parameters
@@ -399,7 +399,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update
Trigger Manual Upgrade for Managed Cluster
Trigger manual upgrade for managed cluster
Trigger Manual Upgrade for Managed Cluster.
AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API.
@@ -443,7 +443,7 @@ with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to trigger manual upgrade. # str | ID of managed cluster to trigger manual upgrade.
try:
# Trigger Manual Upgrade for Managed Cluster
# Trigger manual upgrade for managed cluster
results = ManagedClustersApi(api_client).update(id=id)
# Below is a request that includes all optional parameters
@@ -459,7 +459,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-managed-cluster
Update Managed Cluster
Update managed cluster
Update an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster)
@@ -505,7 +505,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object.
try:
# Update Managed Cluster
# Update managed cluster
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

78
docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md
View File

@@ -18,23 +18,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
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` | List Account-Aggregation-Groups by Multi-Host ID
[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by 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&#39;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) | **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` | List account-aggregation-groups by multi-host id
[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by 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&#39;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
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.
@@ -105,7 +105,7 @@ with ApiClient(configuration) as api_client:
}''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create
try:
# Create Multi-Host Integration
# Create multi-host integration
new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create)
results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create)
# Below is a request that includes all optional parameters
@@ -121,7 +121,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-sources-within-multi-host
Create Sources Within Multi-Host Integration
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.
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
multi_host_integrations_create_sources = '''[sailpoint.v2024.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration.
try:
# Create Sources Within Multi-Host Integration
# Create sources within multi-host integration
new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources)
MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources)
# Below is a request that includes all optional parameters
@@ -182,7 +182,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-multi-host
Delete Multi-Host Integration
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.
@@ -226,7 +226,7 @@ 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
# Delete multi-host integration
MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-acct-aggregation-groups
List Account-Aggregation-Groups by Multi-Host ID
List account-aggregation-groups by multi-host 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.
@@ -288,7 +288,7 @@ 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)
try:
# List Account-Aggregation-Groups by Multi-Host ID
# List account-aggregation-groups by multi-host id
results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
@@ -305,7 +305,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-entitlement-aggregation-groups
List Entitlement-Aggregation-Groups by Integration ID
List entitlement-aggregation-groups by 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.
@@ -354,7 +354,7 @@ 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)
try:
# List Entitlement-Aggregation-Groups by Integration ID
# List entitlement-aggregation-groups by integration id
results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id)
# Below is a request that includes all optional parameters
@@ -371,7 +371,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-multi-host-integrations
Get Multi-Host Integration By ID
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.
@@ -416,7 +416,7 @@ 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
# Get multi-host integration by id
results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
@@ -432,7 +432,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-multi-host-integrations-list
List All Existing Multi-Host Integrations
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.
@@ -487,7 +487,7 @@ 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 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
# List all existing multi-host integrations
results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list()
# Below is a request that includes all optional parameters
@@ -504,7 +504,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-multi-host-source-creation-errors
List 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.
@@ -549,7 +549,7 @@ 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
# List multi-host source creation errors
results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id)
# Below is a request that includes all optional parameters
@@ -566,7 +566,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-multihost-integration-types
List Multi-Host 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.
@@ -607,7 +607,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Multi-Host Integration Types
# List multi-host integration types
results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
# Below is a request that includes all optional parameters
@@ -624,7 +624,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sources-within-multi-host
List Sources Within Multi-Host Integration
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.
@@ -679,7 +679,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# List sources within multi-host integration
results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
@@ -696,7 +696,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-connection-multi-host-sources
Test Configuration For Multi-Host Integration
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.
@@ -740,7 +740,7 @@ 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
# Test configuration for multi-host integration
MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
@@ -754,7 +754,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-source-connection-multihost
Test Configuration For Multi-Host Integration's Single Source
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.
@@ -801,7 +801,7 @@ with ApiClient(configuration) as api_client:
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
# Test configuration for multi-host integration's single source
results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id)
# Below is a request that includes all optional parameters
@@ -817,7 +817,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-multi-host-sources
Update Multi-Host Integration
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.
@@ -864,7 +864,7 @@ with ApiClient(configuration) as api_client:
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
# Update multi-host integration
new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner)
MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner)
# Below is a request that includes all optional parameters

180
docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -46,42 +46,42 @@ 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
[**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-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
[**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
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)
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeApprovalDecision |
try:
# Approve a Non-Employee Request
# Approve a non-employee request
new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision)
results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision)
# Below is a request that includes all optional parameters
@@ -144,7 +144,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-record
Create Non-Employee Record
Create non-employee record
This request will create a non-employee record.
Requires role context of `idn:nesr:create`
@@ -201,7 +201,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRequestBody | Non-Employee record creation request body.
try:
# Create Non-Employee Record
# Create non-employee record
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
@@ -217,7 +217,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-request
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)
@@ -273,7 +273,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRequestBody | Non-Employee creation request body
try:
# Create Non-Employee Request
# Create non-employee request
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
@@ -289,7 +289,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-source
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)
@@ -357,7 +357,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body.
try:
# Create Non-Employee Source
# Create non-employee source
new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body)
# Below is a request that includes all optional parameters
@@ -373,7 +373,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-source-schema-attributes
Create a new Schema Attribute for Non-Employee Source
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`
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeSchemaAttributeBody |
try:
# Create a new Schema Attribute for Non-Employee Source
# Create a new schema attribute for non-employee source
new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body)
# Below is a request that includes all optional parameters
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-record
Delete Non-Employee Record
Delete non-employee record
This request will delete a non-employee record.
Requires role context of `idn:nesr:delete`
@@ -484,7 +484,7 @@ 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
# Delete non-employee record
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id)
# Below is a request that includes all optional parameters
@@ -498,7 +498,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-records-in-bulk
Delete Multiple Non-Employee Records
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)
@@ -540,7 +540,7 @@ 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
# Delete multiple non-employee records
new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request)
# Below is a request that includes all optional parameters
@@ -554,7 +554,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-request
Delete Non-Employee Request
Delete non-employee request
This request will delete a non-employee request.
Requires role context of `idn:nesr:delete`
@@ -597,7 +597,7 @@ 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
# Delete non-employee request
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id)
# Below is a request that includes all optional parameters
@@ -611,7 +611,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-schema-attribute
Delete a Schema Attribute for Non-Employee Source
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`
@@ -656,7 +656,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# Delete a Schema Attribute for Non-Employee Source
# Delete a schema attribute for non-employee source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id)
# Below is a request that includes all optional parameters
@@ -670,7 +670,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-source
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)
@@ -711,7 +711,7 @@ with ApiClient(configuration) as api_client:
source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id
try:
# Delete Non-Employee Source
# Delete non-employee source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -725,7 +725,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-source-schema-attributes
Delete all custom schema attributes for Non-Employee Source
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)
@@ -766,7 +766,7 @@ 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
# Delete all custom schema attributes for non-employee source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -780,7 +780,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-non-employee-records
Exports Non-Employee Records to CSV
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)
@@ -822,7 +822,7 @@ with ApiClient(configuration) as api_client:
id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID)
try:
# Exports Non-Employee Records to CSV
# Exports non-employee records to csv
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id)
# Below is a request that includes all optional parameters
@@ -836,7 +836,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-non-employee-source-schema-template
Exports 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)
@@ -878,7 +878,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID)
try:
# Exports Source Schema Template
# Exports source schema template
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id)
# Below is a request that includes all optional parameters
@@ -955,7 +955,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-approval-summary
Get Summary of Non-Employee Approval Requests
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.
@@ -1001,7 +1001,7 @@ 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
# Get summary of non-employee approval requests
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for)
# Below is a request that includes all optional parameters
@@ -1077,7 +1077,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-record
Get a Non-Employee Record
Get a non-employee record
This gets a non-employee record.
Requires role context of `idn:nesr:read`
@@ -1120,7 +1120,7 @@ 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
# Get a non-employee record
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id)
# Below is a request that includes all optional parameters
@@ -1136,7 +1136,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-request
Get a 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
@@ -1183,7 +1183,7 @@ 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
# Get a non-employee request
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id)
# Below is a request that includes all optional parameters
@@ -1199,7 +1199,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-request-summary
Get Summary of Non-Employee Requests
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.
@@ -1245,7 +1245,7 @@ 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
# Get summary of non-employee requests
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for)
# Below is a request that includes all optional parameters
@@ -1261,7 +1261,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-schema-attribute
Get Schema Attribute Non-Employee Source
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)
@@ -1305,7 +1305,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# Get Schema Attribute Non-Employee Source
# Get schema attribute non-employee source
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1321,7 +1321,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-source
Get a 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.
@@ -1367,7 +1367,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id
try:
# Get a Non-Employee Source
# Get a non-employee source
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1383,7 +1383,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-source-schema-attributes
List Schema Attributes Non-Employee Source
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.
@@ -1427,7 +1427,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# List Schema Attributes Non-Employee Source
# List schema attributes non-employee source
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1444,7 +1444,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-non-employee-records-in-bulk
Imports, or Updates, Non-Employee Records
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)
@@ -1489,7 +1489,7 @@ with ApiClient(configuration) as api_client:
data = None # bytearray | # bytearray |
try:
# Imports, or Updates, Non-Employee Records
# Imports, or updates, non-employee records
results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data)
# Below is a request that includes all optional parameters
@@ -1505,7 +1505,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-approvals
Get List of Non-Employee Approval Requests
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
@@ -1561,7 +1561,7 @@ with ApiClient(configuration) as api_client:
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
# Get list of non-employee approval requests
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals()
# Below is a request that includes all optional parameters
@@ -1578,7 +1578,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-records
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.
@@ -1630,7 +1630,7 @@ with ApiClient(configuration) as api_client:
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
# List non-employee records
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records()
# Below is a request that includes all optional parameters
@@ -1647,7 +1647,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-requests
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.
@@ -1703,7 +1703,7 @@ with ApiClient(configuration) as api_client:
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
# List non-employee requests
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for)
# Below is a request that includes all optional parameters
@@ -1720,7 +1720,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-sources
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.
@@ -1774,7 +1774,7 @@ with ApiClient(configuration) as api_client:
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
# List non-employee sources
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources()
# Below is a request that includes all optional parameters
@@ -1791,7 +1791,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-record
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.
@@ -1841,7 +1841,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
try:
# Patch Non-Employee Record
# Patch non-employee record
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1857,7 +1857,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-schema-attribute
Patch a Schema Attribute for Non-Employee Source
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`
@@ -1907,7 +1907,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/label, value={new attribute label=null}}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
try:
# Patch a Schema Attribute for Non-Employee Source
# Patch a schema attribute for non-employee source
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1923,7 +1923,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-source
Patch a Non-Employee Source
Patch a non-employee source
patch a non-employee source. (partial update) <br/> 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)
@@ -1968,7 +1968,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Patch a Non-Employee Source
# Patch a non-employee source
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1984,7 +1984,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-non-employee-request
Reject a 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)
@@ -2031,7 +2031,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRejectApprovalDecision |
try:
# Reject a Non-Employee Request
# Reject a non-employee request
new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision)
results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision)
# Below is a request that includes all optional parameters
@@ -2047,7 +2047,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-non-employee-record
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.
@@ -2110,7 +2110,7 @@ with ApiClient(configuration) as api_client:
}''' # 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
# Update non-employee record
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters

90
docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md
View File

@@ -15,21 +15,21 @@ 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**](#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
@@ -44,7 +44,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Verify domain address via 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/v2024/create-domain-dkim)
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
}''' # DomainAddress |
try:
# Verify domain address via DKIM
# Verify domain address via dkim
new_domain_address = DomainAddress.from_json(domain_address)
results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental=x_sail_point_experimental, domain_address=new_domain_address)
# Below is a request that includes all optional parameters
@@ -120,7 +120,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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.
@@ -184,7 +184,7 @@ with ApiClient(configuration) as api_client:
}''' # TemplateDto |
try:
# Create Notification Template
# Create notification template
new_template_dto = TemplateDto.from_json(template_dto)
results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental=x_sail_point_experimental, template_dto=new_template_dto)
# Below is a request that includes all optional parameters
@@ -211,7 +211,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/create-verified-from-address)
@@ -261,7 +261,7 @@ with ApiClient(configuration) as api_client:
}''' # EmailStatusDto |
try:
# Create Verified From Address
# Create verified from address
new_email_status_dto = EmailStatusDto.from_json(email_status_dto)
results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental=x_sail_point_experimental, email_status_dto=new_email_status_dto)
# Below is a request that includes all optional parameters
@@ -288,7 +288,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Bulk Delete Notification Templates
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)
@@ -333,7 +333,7 @@ with ApiClient(configuration) as api_client:
template_bulk_delete_dto = '''[sailpoint.v2024.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] |
try:
# Bulk Delete Notification Templates
# Bulk delete notification templates
new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto)
NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental=x_sail_point_experimental, template_bulk_delete_dto=new_template_bulk_delete_dto)
# Below is a request that includes all optional parameters
@@ -358,7 +358,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Verified From Address
Delete verified from address
Delete a verified sender email address
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address)
@@ -403,7 +403,7 @@ 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:
# Delete Verified From Address
# Delete verified from address
NotificationsApi(api_client).delete_verified_from_address(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -428,7 +428,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/get-dkim-attributes)
@@ -471,7 +471,7 @@ 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
# Get dkim attributes
results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -499,7 +499,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/get-mail-from-attributes)
@@ -544,7 +544,7 @@ 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 MAIL FROM Attributes
# Get mail from attributes
results = NotificationsApi(api_client).get_mail_from_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -571,7 +571,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Notification Template By Id
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)
@@ -616,7 +616,7 @@ 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 By Id
# Get notification template by id
results = NotificationsApi(api_client).get_notification_template(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -643,7 +643,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Notification 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).
@@ -687,7 +687,7 @@ 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
# Get notification template context
results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -714,7 +714,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/list-from-addresses)
@@ -766,7 +766,7 @@ with ApiClient(configuration) as api_client:
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
# List from addresses
results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -794,7 +794,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Notification Preferences for tenant.
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)
@@ -838,7 +838,7 @@ 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.
# List notification preferences for tenant.
results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -865,7 +865,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/list-notification-template-defaults)
@@ -914,7 +914,7 @@ with ApiClient(configuration) as api_client:
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
# List notification template defaults
results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -942,7 +942,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/list-notification-templates)
@@ -991,7 +991,7 @@ with ApiClient(configuration) as api_client:
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
# List notification templates
results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -1019,7 +1019,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Change MAIL FROM domain
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)
@@ -1068,7 +1068,7 @@ with ApiClient(configuration) as api_client:
}''' # MailFromAttributesDto |
try:
# Change MAIL FROM domain
# Change mail from domain
new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto)
results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental=x_sail_point_experimental, mail_from_attributes_dto=new_mail_from_attributes_dto)
# Below is a request that includes all optional parameters
@@ -1095,7 +1095,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Send Test Notification
Send test notification
Send a Test Notification
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification)
@@ -1145,7 +1145,7 @@ with ApiClient(configuration) as api_client:
}''' # SendTestNotificationRequestDto |
try:
# Send Test Notification
# Send test notification
new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto)
NotificationsApi(api_client).send_test_notification(x_sail_point_experimental=x_sail_point_experimental, send_test_notification_request_dto=new_send_test_notification_request_dto)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md
View File

@@ -18,15 +18,15 @@ 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) | **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
Create oauth client
This creates an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-oauth-client)
@@ -85,7 +85,7 @@ with ApiClient(configuration) as api_client:
}''' # CreateOAuthClientRequest |
try:
# Create OAuth Client
# Create oauth client
new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request)
results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request)
# Below is a request that includes all optional parameters
@@ -101,7 +101,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-oauth-client
Delete OAuth Client
Delete oauth client
This deletes an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client)
@@ -143,7 +143,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Delete OAuth Client
# Delete oauth client
OAuthClientsApi(api_client).delete_oauth_client(id=id)
# Below is a request that includes all optional parameters
@@ -157,7 +157,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-oauth-client
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)
@@ -200,7 +200,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Get OAuth Client
# Get oauth client
results = OAuthClientsApi(api_client).get_oauth_client(id=id)
# Below is a request that includes all optional parameters
@@ -216,7 +216,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-oauth-clients
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)
@@ -258,7 +258,7 @@ 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
# List oauth clients
results = OAuthClientsApi(api_client).list_oauth_clients()
# Below is a request that includes all optional parameters
@@ -275,7 +275,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-oauth-client
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)
@@ -321,7 +321,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
try:
# Patch OAuth Client
# Patch oauth client
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md
View File

@@ -17,9 +17,9 @@ 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**](#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
@@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Org Config Settings
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)
@@ -78,7 +78,7 @@ 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
# Get org config settings
results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -105,7 +105,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Valid Time Zones
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)
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Get valid time zones
results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -181,7 +181,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch Org Config
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)
@@ -228,7 +228,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Patch Org Config
# Patch org config
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md
View File

@@ -21,13 +21,13 @@ 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) | **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
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'
@@ -76,7 +76,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordOrgConfig |
try:
# Create Password Org Config
# Create password org config
new_password_org_config = PasswordOrgConfig.from_json(password_org_config)
results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config)
# Below is a request that includes all optional parameters
@@ -92,7 +92,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-password-org-config
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)
@@ -130,7 +130,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Org Config
# Get password org config
results = PasswordConfigurationApi(api_client).get_password_org_config()
# Below is a request that includes all optional parameters
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-password-org-config
Update 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'
@@ -195,7 +195,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordOrgConfig |
try:
# Update Password Org Config
# Update password org config
new_password_org_config = PasswordOrgConfig.from_json(password_org_config)
results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md
View File

@@ -62,12 +62,12 @@ 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) | **GET** `/password-dictionary` | Get password dictionary
[**put-password-dictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary
## get-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
@@ -133,7 +133,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Dictionary
# Get password dictionary
results = PasswordDictionaryApi(api_client).get_password_dictionary()
# Below is a request that includes all optional parameters
@@ -149,7 +149,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-password-dictionary
Update 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
@@ -220,7 +220,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | (optional) # bytearray | (optional)
try:
# Update Password Dictionary
# Update password dictionary
PasswordDictionaryApi(api_client).put_password_dictionary()
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md
View File

@@ -40,9 +40,9 @@ 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&#39;s Password
[**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&#39;s password
## create-digit-token
@@ -123,7 +123,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-password-change-status
Get Password Change Request 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)
@@ -166,7 +166,7 @@ with ApiClient(configuration) as api_client:
id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID
try:
# Get Password Change Request Status
# Get password change request status
results = PasswordManagementApi(api_client).get_password_change_status(id=id)
# Below is a request that includes all optional parameters
@@ -182,7 +182,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## query-password-info
Query Password Info
Query password info
This API is used to query password related information.
@@ -229,7 +229,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordInfoQueryDTO |
try:
# Query Password Info
# Query password info
new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto)
results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto)
# Below is a request that includes all optional parameters
@@ -245,7 +245,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-password
Set Identity's 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).
@@ -313,7 +313,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordChangeRequest |
try:
# Set Identity's Password
# Set identity's password
new_password_change_request = PasswordChangeRequest.from_json(password_change_request)
results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md
View File

@@ -23,15 +23,15 @@ 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) | **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
Create password policy
This API creates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-policy)
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordPolicyV3Dto |
try:
# Create Password Policy
# Create password policy
new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
@@ -122,7 +122,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-password-policy
Delete Password Policy by ID
Delete password policy by id
This API deletes the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-policy)
@@ -164,7 +164,7 @@ 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
# Delete password policy by id
PasswordPoliciesApi(api_client).delete_password_policy(id=id)
# Below is a request that includes all optional parameters
@@ -178,7 +178,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-password-policy-by-id
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)
@@ -221,7 +221,7 @@ 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
# Get password policy by id
results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -237,7 +237,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-password-policies
List Password Policies
List password policies
This gets list of all Password Policies.
Requires role of ORG_ADMIN
@@ -284,7 +284,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# List password policies
results = PasswordPoliciesApi(api_client).list_password_policies()
# Below is a request that includes all optional parameters
@@ -301,7 +301,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-password-policy
Update Password Policy by ID
Update password policy by id
This API updates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password-policy)
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordPolicyV3Dto |
try:
# Update Password Policy by ID
# Update password policy by id
new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md
View File

@@ -47,15 +47,15 @@ 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) | **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
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)
@@ -104,7 +104,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordSyncGroup |
try:
# Create Password Sync Group
# Create password sync group
new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group)
results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group)
# Below is a request that includes all optional parameters
@@ -120,7 +120,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-password-sync-group
Delete Password Sync Group by ID
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)
@@ -161,7 +161,7 @@ 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
# Delete password sync group by id
PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id)
# Below is a request that includes all optional parameters
@@ -175,7 +175,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-password-sync-group
Get Password Sync Group by ID
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)
@@ -218,7 +218,7 @@ 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
# Get password sync group by id
results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id)
# Below is a request that includes all optional parameters
@@ -234,7 +234,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-password-sync-groups
Get Password Sync Group List
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)
@@ -280,7 +280,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Get password sync group list
results = PasswordSyncGroupsApi(api_client).get_password_sync_groups()
# Below is a request that includes all optional parameters
@@ -297,7 +297,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-password-sync-group
Update Password Sync Group by ID
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)
@@ -349,7 +349,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordSyncGroup |
try:
# Update Password Sync Group by ID
# Update password sync group by id
new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group)
results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md
View File

@@ -26,14 +26,14 @@ 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) | **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
Create personal access token
This creates a personal access token.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-personal-access-token)
@@ -80,7 +80,7 @@ with ApiClient(configuration) as api_client:
}''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token.
try:
# Create Personal Access Token
# Create personal access token
new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request)
results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request)
# Below is a request that includes all optional parameters
@@ -96,7 +96,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-personal-access-token
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)
@@ -138,7 +138,7 @@ 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
# Delete personal access token
PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id)
# Below is a request that includes all optional parameters
@@ -152,7 +152,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-personal-access-tokens
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)
@@ -196,7 +196,7 @@ 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 Personal Access Tokens
# List personal access tokens
results = PersonalAccessTokensApi(api_client).list_personal_access_tokens()
# Below is a request that includes all optional parameters
@@ -213,7 +213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-personal-access-token
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.
@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
try:
# Patch Personal Access Token
# Patch personal access token
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md
View File

@@ -25,12 +25,12 @@ 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-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
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)
@@ -68,7 +68,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the Public Identities Configuration
# Get the public identities configuration
results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
# Below is a request that includes all optional parameters
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-public-identity-config
Update the Public Identities Configuration
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)
@@ -140,7 +140,7 @@ with ApiClient(configuration) as api_client:
}''' # PublicIdentityConfig |
try:
# Update the Public Identities Configuration
# Update the public identities configuration
new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config)
results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md
View File

@@ -18,14 +18,14 @@ 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) | **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
Cancel report
Cancels a running report.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report)
@@ -66,7 +66,7 @@ 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
# Cancel report
ReportsDataExtractionApi(api_client).cancel_report(id=id)
# Below is a request that includes all optional parameters
@@ -80,7 +80,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-report
Get Report File
Get report file
Gets a report in file format.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report)
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
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
# Get report file
results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format)
# Below is a request that includes all optional parameters
@@ -144,7 +144,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-report-result
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)
@@ -188,7 +188,7 @@ with ApiClient(configuration) as api_client:
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
# Get report result
results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id)
# Below is a request that includes all optional parameters
@@ -204,7 +204,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-report
Run 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)
@@ -253,7 +253,7 @@ with ApiClient(configuration) as api_client:
}''' # ReportDetails |
try:
# Run Report
# Run report
new_report_details = ReportDetails.from_json(report_details)
results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md
View File

@@ -18,11 +18,11 @@ 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**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list
## list-requestable-objects
Requestable Objects List
Requestable objects list
Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter.
Any authenticated token can call this endpoint to see their requestable access items.
@@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client:
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
# Requestable objects list
results = RequestableObjectsApi(api_client).list_requestable_objects()
# Below is a request that includes all optional parameters

96
docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md
View File

@@ -52,26 +52,26 @@ 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&#39;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&#39; Metadata by Filters
[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles&#39; Metadata by ID
[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles&#39; Metadata by Query
[**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&#39;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&#39; metadata by filters
[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-update roles&#39; metadata by id
[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-update roles&#39; metadata by query
## create-role
Create a 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.
@@ -277,7 +277,7 @@ with ApiClient(configuration) as api_client:
}''' # Role |
try:
# Create a Role
# Create a role
new_role = Role.from_json(role)
results = RolesApi(api_client).create_role(role=new_role)
# Below is a request that includes all optional parameters
@@ -293,7 +293,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-bulk-roles
Delete Role(s)
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.
@@ -341,7 +341,7 @@ with ApiClient(configuration) as api_client:
}''' # RoleBulkDeleteRequest |
try:
# Delete Role(s)
# Delete role(s)
new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request)
results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request)
# Below is a request that includes all optional parameters
@@ -357,7 +357,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-metadata-from-role-by-key-and-value
Remove a Metadata From Role.
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)
@@ -402,7 +402,7 @@ with ApiClient(configuration) as api_client:
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
try:
# Remove a Metadata From Role.
# Remove a metadata from role.
RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
@@ -416,7 +416,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-role
Delete a 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.
@@ -459,7 +459,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Delete a Role
# Delete a role
RolesApi(api_client).delete_role(id=id)
# Below is a request that includes all optional parameters
@@ -473,7 +473,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-bulk-update-status
Get Bulk-Update Statuses
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)
@@ -511,7 +511,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Bulk-Update Statuses
# Get bulk-update statuses
results = RolesApi(api_client).get_bulk_update_status()
# Below is a request that includes all optional parameters
@@ -528,7 +528,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-bulk-update-status-by-id
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.
@@ -572,7 +572,7 @@ 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
# Get bulk-update status by id
results = RolesApi(api_client).get_bulk_update_status_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -588,7 +588,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role
Get a 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.
@@ -631,7 +631,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Get a Role
# Get a role
results = RolesApi(api_client).get_role(id=id)
# Below is a request that includes all optional parameters
@@ -647,7 +647,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role-assigned-identities
List Identities assigned a Role
List identities assigned a role
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assigned-identities)
@@ -699,7 +699,7 @@ with ApiClient(configuration) as api_client:
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
# List identities assigned a role
results = RolesApi(api_client).get_role_assigned_identities(id=id)
# Below is a request that includes all optional parameters
@@ -727,7 +727,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Role's Entitlements
List role's entitlements
Get a list of entitlements associated with a specified role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-entitlements)
@@ -782,7 +782,7 @@ with ApiClient(configuration) as api_client:
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
# List role's entitlements
results = RolesApi(api_client).get_role_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -799,7 +799,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-roles
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.
@@ -857,7 +857,7 @@ with ApiClient(configuration) as api_client:
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
# List roles
results = RolesApi(api_client).list_roles()
# Below is a request that includes all optional parameters
@@ -874,7 +874,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-role
Patch a specified 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:
@@ -939,7 +939,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Role
# Patch a specified role
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -955,7 +955,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-roles-by-filter
Filter Roles by Metadata
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.
@@ -1019,7 +1019,7 @@ with ApiClient(configuration) as api_client:
}''' # RoleListFilterDTO | (optional)
try:
# Filter Roles by Metadata
# Filter roles by metadata
results = RolesApi(api_client).search_roles_by_filter()
# Below is a request that includes all optional parameters
@@ -1035,7 +1035,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-attribute-key-and-value-to-role
Add a Metadata 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)
@@ -1081,7 +1081,7 @@ with ApiClient(configuration) as api_client:
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
try:
# Add a Metadata to Role.
# Add a metadata to role.
results = RolesApi(api_client).update_attribute_key_and_value_to_role(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
@@ -1097,7 +1097,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-roles-metadata-by-filter
Bulk-Update Roles' Metadata by Filters
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.
@@ -1151,7 +1151,7 @@ with ApiClient(configuration) as api_client:
}''' # RoleMetadataBulkUpdateByFilterRequest |
try:
# Bulk-Update Roles' Metadata by Filters
# Bulk-update roles' metadata by filters
new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest.from_json(role_metadata_bulk_update_by_filter_request)
results = RolesApi(api_client).update_roles_metadata_by_filter(role_metadata_bulk_update_by_filter_request=new_role_metadata_bulk_update_by_filter_request)
# Below is a request that includes all optional parameters
@@ -1167,7 +1167,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-roles-metadata-by-ids
Bulk-Update Roles' Metadata by ID
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.
@@ -1221,7 +1221,7 @@ with ApiClient(configuration) as api_client:
}''' # RoleMetadataBulkUpdateByIdRequest |
try:
# Bulk-Update Roles' Metadata by ID
# Bulk-update roles' metadata by id
new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest.from_json(role_metadata_bulk_update_by_id_request)
results = RolesApi(api_client).update_roles_metadata_by_ids(role_metadata_bulk_update_by_id_request=new_role_metadata_bulk_update_by_id_request)
# Below is a request that includes all optional parameters
@@ -1237,7 +1237,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-roles-metadata-by-query
Bulk-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.
@@ -1306,7 +1306,7 @@ with ApiClient(configuration) as api_client:
}''' # RoleMetadataBulkUpdateByQueryRequest |
try:
# Bulk-Update Roles' Metadata by Query
# Bulk-update roles' metadata by query
new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest.from_json(role_metadata_bulk_update_by_query_request)
results = RolesApi(api_client).update_roles_metadata_by_query(role_metadata_bulk_update_by_query_request=new_role_metadata_bulk_update_by_query_request)
# Below is a request that includes all optional parameters

42
docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md
View File

@@ -22,13 +22,13 @@ 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**](#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
@@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create new SIM integration
Create new sim integration
Create a new SIM Integrations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration)
@@ -107,7 +107,7 @@ with ApiClient(configuration) as api_client:
}''' # SimIntegrationDetails | DTO containing the details of the SIM integration
try:
# Create new SIM integration
# Create new sim integration
new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details)
results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details)
# Below is a request that includes all optional parameters
@@ -134,7 +134,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete a SIM integration
Delete a sim integration
Get the details of a SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration)
@@ -179,7 +179,7 @@ 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:
# Delete a SIM integration
# Delete a sim integration
SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -204,7 +204,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get a SIM integration details.
Get a sim integration details.
Get the details of a SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration)
@@ -250,7 +250,7 @@ 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 SIM integration details.
# Get a sim integration details.
results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -277,7 +277,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List the existing SIM integrations.
List the existing sim integrations.
List the existing SIM integrations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations)
@@ -321,7 +321,7 @@ 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.
# List the existing sim integrations.
results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -349,7 +349,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch a SIM beforeProvisioningRule attribute.
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)
@@ -408,7 +408,7 @@ with ApiClient(configuration) as api_client:
}''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
try:
# Patch a SIM beforeProvisioningRule attribute.
# Patch a sim beforeprovisioningrule attribute.
new_json_patch = JsonPatch.from_json(json_patch)
results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
@@ -435,7 +435,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch a SIM attribute.
Patch a sim attribute.
Patch a SIM attribute given a JsonPatch object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes)
@@ -494,7 +494,7 @@ with ApiClient(configuration) as api_client:
}''' # JsonPatch | The JsonPatch object that describes the changes of SIM
try:
# Patch a SIM attribute.
# Patch a sim attribute.
new_json_patch = JsonPatch.from_json(json_patch)
results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
@@ -521,7 +521,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update an existing SIM integration
Update an existing sim integration
Update an existing SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration)
@@ -587,7 +587,7 @@ with ApiClient(configuration) as api_client:
}''' # SimIntegrationDetails | The full DTO of the integration containing the updated model
try:
# Update an existing SIM integration
# Update an existing sim integration
new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details)
results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details)
# Below is a request that includes all optional parameters

72
docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md
View File

@@ -41,27 +41,27 @@ 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
[**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-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
[**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
[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report
## create-sod-policy
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.
@@ -159,7 +159,7 @@ with ApiClient(configuration) as api_client:
}''' # SodPolicy |
try:
# Create SOD policy
# Create sod policy
new_sod_policy = SodPolicy.from_json(sod_policy)
results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy)
# Below is a request that includes all optional parameters
@@ -175,7 +175,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-sod-policy
Delete SOD policy by ID
Delete sod policy by id
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -220,7 +220,7 @@ with ApiClient(configuration) as api_client:
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
# Delete sod policy by id
SODPoliciesApi(api_client).delete_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -234,7 +234,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-sod-policy-schedule
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)
@@ -276,7 +276,7 @@ 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
# Delete sod policy schedule
SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -462,7 +462,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sod-policy
Get SOD policy by ID
Get sod policy by id
This gets specified SOD policy.
Requires role of ORG_ADMIN.
@@ -506,7 +506,7 @@ 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
# Get sod policy by id
results = SODPoliciesApi(api_client).get_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -522,7 +522,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sod-policy-schedule
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)
@@ -564,7 +564,7 @@ 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
# Get sod policy schedule
results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -639,7 +639,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sod-violation-report-status
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)
@@ -682,7 +682,7 @@ 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
# Get sod violation report status
results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id)
# Below is a request that includes all optional parameters
@@ -698,7 +698,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-sod-policies
List SOD policies
List sod policies
This gets list of all SOD policies.
Requires role of ORG_ADMIN
@@ -749,7 +749,7 @@ with ApiClient(configuration) as api_client:
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
# List sod policies
results = SODPoliciesApi(api_client).list_sod_policies()
# Below is a request that includes all optional parameters
@@ -766,7 +766,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-sod-policy
Patch SOD policy by ID
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.
@@ -814,7 +814,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
try:
# Patch SOD policy by ID
# Patch sod policy by id
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -830,7 +830,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-policy-schedule
Update SOD 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)
@@ -959,7 +959,7 @@ with ApiClient(configuration) as api_client:
}''' # SodPolicySchedule |
try:
# Update SOD Policy schedule
# Update sod policy schedule
new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule)
results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule)
# Below is a request that includes all optional parameters
@@ -975,7 +975,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-sod-policy
Update SOD policy by ID
Update sod policy by id
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -1076,7 +1076,7 @@ with ApiClient(configuration) as api_client:
}''' # SodPolicy |
try:
# Update SOD policy by ID
# Update sod policy by id
new_sod_policy = SodPolicy.from_json(sod_policy)
results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy)
# Below is a request that includes all optional parameters
@@ -1092,7 +1092,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-evaluate-sod-policy
Evaluate one policy by ID
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)
@@ -1134,7 +1134,7 @@ 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
# Evaluate one policy by id
results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -1211,7 +1211,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-sod-policy
Runs SOD policy violation report
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)
@@ -1254,7 +1254,7 @@ 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
# Runs sod policy violation report
results = SODPoliciesApi(api_client).start_sod_policy(id=id)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md
View File

@@ -33,12 +33,12 @@ 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**](#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.
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)
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityWithNewAccess |
try:
# Predict SOD violations for identity.
# Predict sod violations for identity.
new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access)
results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access)
# Below is a request that includes all optional parameters
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-violation-check
Check SOD violations
Check sod violations
This API initiates a SOD policy verification asynchronously.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-violation-check)
@@ -153,7 +153,7 @@ 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
# Check sod violations
new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1)
results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md
View File

@@ -21,7 +21,7 @@ Method | HTTP request | Description
[**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` | List Config Objects
[**list-sp-config-objects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List config objects
## export-sp-config
@@ -408,7 +408,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-sp-config-objects
List Config Objects
List config objects
Get a list of object configurations that the tenant export/import service knows.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects)
@@ -447,7 +447,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Config Objects
# List config objects
results = SPConfigApi(api_client).list_sp_config_objects()
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md
View File

@@ -26,10 +26,10 @@ 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
[**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
@@ -94,7 +94,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-saved-search
Delete document by ID
Delete document by id
Deletes the specified saved search.
@@ -137,7 +137,7 @@ 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
# Delete document by id
SavedSearchApi(api_client).delete_saved_search(id=id)
# Below is a request that includes all optional parameters
@@ -151,7 +151,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## execute-saved-search
Execute a saved search by ID
Execute a saved search by id
Executes the specified saved search.
@@ -207,7 +207,7 @@ with ApiClient(configuration) as api_client:
}''' # 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
# Execute a saved search by id
new_search_arguments = SearchArguments.from_json(search_arguments)
SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments)
# Below is a request that includes all optional parameters
@@ -221,7 +221,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-saved-search
Return saved search by ID
Return saved search by id
Returns the specified saved search.
@@ -265,7 +265,7 @@ 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
# Return saved search by id
results = SavedSearchApi(api_client).get_saved_search(id=id)
# Below is a request that includes all optional parameters
@@ -281,7 +281,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-saved-searches
A list of Saved Searches
A list of saved searches
Returns a list of saved searches.
@@ -330,7 +330,7 @@ with ApiClient(configuration) as api_client:
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
# A list of saved searches
results = SavedSearchApi(api_client).list_saved_searches()
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md
View File

@@ -42,11 +42,11 @@ 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
[**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
[**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
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-scheduled-search
Delete a Scheduled Search
Delete a scheduled search
Deletes the specified scheduled search.
@@ -154,7 +154,7 @@ 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
# Delete a scheduled search
ScheduledSearchApi(api_client).delete_scheduled_search(id=id)
# Below is a request that includes all optional parameters
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-scheduled-search
Get a Scheduled Search
Get a scheduled search
Returns the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-scheduled-search)
@@ -211,7 +211,7 @@ 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
# Get a scheduled search
results = ScheduledSearchApi(api_client).get_scheduled_search(id=id)
# Below is a request that includes all optional parameters
@@ -294,7 +294,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## unsubscribe-scheduled-search
Unsubscribe a recipient from Scheduled Search
Unsubscribe a recipient from scheduled search
Unsubscribes a recipient from the specified scheduled search.
@@ -340,7 +340,7 @@ with ApiClient(configuration) as api_client:
}''' # TypedReference | The recipient to be removed from the scheduled search.
try:
# Unsubscribe a recipient from Scheduled Search
# Unsubscribe a recipient from scheduled search
new_typed_reference = TypedReference.from_json(typed_reference)
ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference)
# Below is a request that includes all optional parameters
@@ -354,7 +354,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-scheduled-search
Update an existing Scheduled Search
Update an existing scheduled search
Updates an existing scheduled search.
@@ -490,7 +490,7 @@ with ApiClient(configuration) as api_client:
}''' # ScheduledSearch | The scheduled search to persist.
try:
# Update an existing Scheduled Search
# Update an existing scheduled search
new_scheduled_search = ScheduledSearch.from_json(scheduled_search)
results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md
View File

@@ -38,14 +38,14 @@ 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**](#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
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)
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Perform a search query aggregation
new_search = Search.from_json(search)
results = SearchApi(api_client).search_aggregate(search=new_search)
# Below is a request that includes all optional parameters
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-count
Count Documents Satisfying a Query
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)
@@ -384,7 +384,7 @@ with ApiClient(configuration) as api_client:
}''' # Search |
try:
# Count Documents Satisfying a Query
# Count documents satisfying a query
new_search = Search.from_json(search)
SearchApi(api_client).search_count(search=new_search)
# Below is a request that includes all optional parameters
@@ -398,7 +398,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-get
Get a Document by ID
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)
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Document by ID
# Get a document by id
results = SearchApi(api_client).search_get(index=index, id=id)
# Below is a request that includes all optional parameters
@@ -458,7 +458,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-post
Perform Search
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)
@@ -622,7 +622,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Perform search
new_search = Search.from_json(search)
results = SearchApi(api_client).search_post(search=new_search)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md
View File

@@ -33,11 +33,11 @@ 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**](#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
@@ -52,7 +52,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create Extended Search Attributes
Create extended search attributes
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig.
>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.**
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
}''' # SearchAttributeConfig |
try:
# Create Extended Search Attributes
# Create extended search attributes
new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config)
results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental, search_attribute_config=new_search_attribute_config)
# Below is a request that includes all optional parameters
@@ -133,7 +133,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Extended Search Attribute
Delete extended search attribute
Delete an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config)
@@ -177,7 +177,7 @@ 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:
# Delete Extended Search Attribute
# Delete extended search attribute
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -202,7 +202,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Extended Search Attributes
List extended search attributes
Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config)
@@ -249,7 +249,7 @@ 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)
try:
# List Extended Search Attributes
# List extended search attributes
results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -277,7 +277,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Extended Search Attribute
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)
@@ -323,7 +323,7 @@ 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 Extended Search Attribute
# Get extended search attribute
results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -350,7 +350,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Extended Search Attribute
Update extended search attribute
Update an existing search attribute configuration.
You can patch these fields:
* name * displayName * applicationAttributes
@@ -401,7 +401,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] |
try:
# Update Extended Search Attribute
# Update extended search attribute
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md
View File

@@ -32,15 +32,15 @@ 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) | **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
Create segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
}''' # Segment |
try:
# Create Segment
# Create segment
new_segment = Segment.from_json(segment)
results = SegmentsApi(api_client).create_segment(segment=new_segment)
# Below is a request that includes all optional parameters
@@ -122,7 +122,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-segment
Delete Segment by ID
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.
@@ -165,7 +165,7 @@ 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
# Delete segment by id
SegmentsApi(api_client).delete_segment(id=id)
# Below is a request that includes all optional parameters
@@ -179,7 +179,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-segment
Get Segment by ID
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)
@@ -222,7 +222,7 @@ 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
# Get segment by id
results = SegmentsApi(api_client).get_segment(id=id)
# Below is a request that includes all optional parameters
@@ -238,7 +238,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-segments
List Segments
List segments
This API returns a list of all segments.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-segments)
@@ -284,7 +284,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# List segments
results = SegmentsApi(api_client).list_segments()
# Below is a request that includes all optional parameters
@@ -301,7 +301,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-segment
Update 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.
@@ -347,7 +347,7 @@ with ApiClient(configuration) as api_client:
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
# Update segment
new_request_body = RequestBody.from_json(request_body)
results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md
View File

@@ -39,20 +39,20 @@ 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
[**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
[**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 new service desk integration
Create a new Service Desk integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-service-desk-integration)
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
}''' # ServiceDeskIntegrationDto | The specifics of a new integration to create
try:
# Create new Service Desk integration
# Create new service desk integration
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
@@ -144,7 +144,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-service-desk-integration
Delete a 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)
@@ -186,7 +186,7 @@ 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
# Delete a service desk integration
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id)
# Below is a request that includes all optional parameters
@@ -200,7 +200,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration
Get a 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)
@@ -243,7 +243,7 @@ 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
# Get a service desk integration
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id)
# Below is a request that includes all optional parameters
@@ -259,7 +259,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration-template
Service Desk integration template by scriptName
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)
@@ -302,7 +302,7 @@ 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
# Service desk integration template by scriptname
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -318,7 +318,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration-types
List 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)
@@ -357,7 +357,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Service Desk integration types
# List service desk integration types
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
# Below is a request that includes all optional parameters
@@ -374,7 +374,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integrations
List existing 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)
@@ -425,7 +425,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# List existing service desk integrations
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations()
# Below is a request that includes all optional parameters
@@ -497,7 +497,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-service-desk-integration
Patch a 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)
@@ -543,7 +543,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | 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
# Patch a service desk integration
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -559,7 +559,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-service-desk-integration
Update a 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)
@@ -637,7 +637,7 @@ with ApiClient(configuration) as api_client:
}''' # ServiceDeskIntegrationDto | The specifics of the integration to update
try:
# Update a Service Desk integration
# Update a service desk integration
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto)
# Below is a request that includes all optional parameters

228
docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md
View File

@@ -72,60 +72,60 @@ 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
[**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-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-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-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id
[**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
[**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.
[**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.
[**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)
[**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)
[**search-resource-objects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector&#39;s resource objects
[**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)
[**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
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.
@@ -211,7 +211,7 @@ with ApiClient(configuration) as api_client:
}''' # ProvisioningPolicyDto |
try:
# Create Provisioning Policy
# Create provisioning policy
new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto)
results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto)
# Below is a request that includes all optional parameters
@@ -227,7 +227,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-source
Creates a source in IdentityNow.
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)
@@ -353,7 +353,7 @@ with ApiClient(configuration) as api_client:
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.
# Creates a source in identitynow.
new_source = Source.from_json(source)
results = SourcesApi(api_client).create_source(source=new_source)
# Below is a request that includes all optional parameters
@@ -369,7 +369,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-source-schedule
Create Schedule on Source
Create schedule on source
Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
@@ -414,7 +414,7 @@ with ApiClient(configuration) as api_client:
schedule1 = '''sailpoint.v2024.Schedule1()''' # Schedule1 |
try:
# Create Schedule on Source
# Create schedule on source
new_schedule1 = Schedule1.from_json(schedule1)
results = SourcesApi(api_client).create_source_schedule(source_id=source_id, schedule1=new_schedule1)
# Below is a request that includes all optional parameters
@@ -430,7 +430,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-source-schema
Create Schema on Source
Create schema on source
Use this API to create a new schema on the specified source in Identity Security Cloud (ISC).
@@ -475,7 +475,7 @@ with ApiClient(configuration) as api_client:
model_schema = '''sailpoint.v2024.ModelSchema()''' # ModelSchema |
try:
# Create Schema on Source
# Create schema on source
new_model_schema = ModelSchema.from_json(model_schema)
results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema)
# Below is a request that includes all optional parameters
@@ -502,7 +502,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Remove All Accounts in a Source
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:
@@ -553,7 +553,7 @@ 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:
# Remove All Accounts in a Source
# Remove all accounts in a source
results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -580,7 +580,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Native Change Detection Configuration
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)
@@ -625,7 +625,7 @@ 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:
# Delete Native Change Detection Configuration
# Delete native change detection configuration
SourcesApi(api_client).delete_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -639,7 +639,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-provisioning-policy
Delete Provisioning Policy by UsageType
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)
@@ -684,7 +684,7 @@ with ApiClient(configuration) as api_client:
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
# Delete provisioning policy by usagetype
SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type)
# Below is a request that includes all optional parameters
@@ -698,7 +698,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-source
Delete Source by ID
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}`
@@ -742,7 +742,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Delete Source by ID
# Delete source by id
results = SourcesApi(api_client).delete_source(id=id)
# Below is a request that includes all optional parameters
@@ -758,7 +758,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-source-schedule
Delete Source Schedule by type.
Delete source schedule by type.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schedule)
@@ -802,7 +802,7 @@ with ApiClient(configuration) as api_client:
schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type.
try:
# Delete Source Schedule by type.
# Delete source schedule by type.
SourcesApi(api_client).delete_source_schedule(source_id=source_id, schedule_type=schedule_type)
# Below is a request that includes all optional parameters
@@ -816,7 +816,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-source-schema
Delete Source Schema by ID
Delete source schema by id
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schema)
@@ -860,7 +860,7 @@ with ApiClient(configuration) as api_client:
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
try:
# Delete Source Schema by ID
# Delete source schema by id
SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id)
# Below is a request that includes all optional parameters
@@ -931,7 +931,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-correlation-config
Get Source Correlation Configuration
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)
@@ -974,7 +974,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id
try:
# Get Source Correlation Configuration
# Get source correlation configuration
results = SourcesApi(api_client).get_correlation_config(id=id)
# Below is a request that includes all optional parameters
@@ -1061,7 +1061,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Native Change Detection Configuration
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)
@@ -1107,7 +1107,7 @@ 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:
# Native Change Detection Configuration
# Native change detection configuration
results = SourcesApi(api_client).get_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -1123,7 +1123,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-provisioning-policy
Get Provisioning Policy by UsageType
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)
@@ -1169,7 +1169,7 @@ with ApiClient(configuration) as api_client:
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
# Get provisioning policy by usagetype
results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type)
# Below is a request that includes all optional parameters
@@ -1185,7 +1185,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source
Get Source by ID
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)
@@ -1228,7 +1228,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source by ID
# Get source by id
results = SourcesApi(api_client).get_source(id=id)
# Below is a request that includes all optional parameters
@@ -1255,7 +1255,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Attribute 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.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-attr-sync-config)
@@ -1301,7 +1301,7 @@ 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:
# Attribute Sync Config
# Attribute sync config
results = SourcesApi(api_client).get_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -1378,7 +1378,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-connections
Get Source Connections by ID
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/v2024/get-source-connections)
@@ -1421,7 +1421,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source Connections by ID
# Get source connections by id
results = SourcesApi(api_client).get_source_connections(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1448,7 +1448,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Source Entitlement Request Configuration
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.
@@ -1495,7 +1495,7 @@ 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
# Get source entitlement request configuration
results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -1570,7 +1570,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-schedule
Get Source Schedule by Type
Get source schedule by type
Get the source schedule by type in Identity Security Cloud (ISC).
@@ -1616,7 +1616,7 @@ with ApiClient(configuration) as api_client:
schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type.
try:
# Get Source Schedule by Type
# Get source schedule by type
results = SourcesApi(api_client).get_source_schedule(source_id=source_id, schedule_type=schedule_type)
# Below is a request that includes all optional parameters
@@ -1632,7 +1632,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-schedules
List Schedules on Source
List schedules on source
Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC).
:::info
This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**.
@@ -1683,7 +1683,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# List Schedules on Source
# List schedules on source
results = SourcesApi(api_client).get_source_schedules(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1700,7 +1700,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-schema
Get Source Schema by ID
Get source schema by id
Get the Source Schema by ID in IdentityNow.
@@ -1746,7 +1746,7 @@ with ApiClient(configuration) as api_client:
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
try:
# Get Source Schema by ID
# Get source schema by id
results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id)
# Below is a request that includes all optional parameters
@@ -1762,7 +1762,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-schemas
List Schemas on Source
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)
@@ -1809,7 +1809,7 @@ with ApiClient(configuration) as api_client:
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
# List schemas on source
results = SourcesApi(api_client).get_source_schemas(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1837,7 +1837,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Account Aggregation
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`.
@@ -1888,7 +1888,7 @@ with ApiClient(configuration) as api_client:
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
# Account aggregation
results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -2109,7 +2109,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Process 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/v2024/import-uncorrelated-accounts)
@@ -2156,7 +2156,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | (optional) # bytearray | (optional)
try:
# Process Uncorrelated Accounts
# Process uncorrelated accounts
results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -2172,7 +2172,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-provisioning-policies
Lists ProvisioningPolicies
Lists provisioningpolicies
This end-point lists all the ProvisioningPolicies in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-provisioning-policies)
@@ -2215,7 +2215,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id
try:
# Lists ProvisioningPolicies
# Lists provisioningpolicies
results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -2232,7 +2232,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-sources
Lists all sources in IdentityNow.
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)
@@ -2287,7 +2287,7 @@ with ApiClient(configuration) as api_client:
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.
# Lists all sources in identitynow.
results = SourcesApi(api_client).list_sources()
# Below is a request that includes all optional parameters
@@ -2363,7 +2363,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-correlation-config
Update Source Correlation Configuration
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)
@@ -2428,7 +2428,7 @@ with ApiClient(configuration) as api_client:
}''' # CorrelationConfig |
try:
# Update Source Correlation Configuration
# Update source correlation configuration
new_correlation_config = CorrelationConfig.from_json(correlation_config)
results = SourcesApi(api_client).put_correlation_config(id=id, correlation_config=new_correlation_config)
# Below is a request that includes all optional parameters
@@ -2455,7 +2455,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Native Change Detection Configuration
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)
@@ -2510,7 +2510,7 @@ with ApiClient(configuration) as api_client:
}''' # NativeChangeDetectionConfig |
try:
# Update Native Change Detection Configuration
# Update native change detection configuration
new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config)
results = SourcesApi(api_client).put_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental, native_change_detection_config=new_native_change_detection_config)
# Below is a request that includes all optional parameters
@@ -2526,7 +2526,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-provisioning-policy
Update Provisioning Policy by UsageType
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.
@@ -2615,7 +2615,7 @@ with ApiClient(configuration) as api_client:
}''' # ProvisioningPolicyDto |
try:
# Update Provisioning Policy by UsageType
# Update provisioning policy by usagetype
new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto)
results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto)
# Below is a request that includes all optional parameters
@@ -2631,7 +2631,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-source
Update Source (Full)
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:
@@ -2770,7 +2770,7 @@ with ApiClient(configuration) as api_client:
}''' # Source |
try:
# Update Source (Full)
# Update source (full)
new_source = Source.from_json(source)
results = SourcesApi(api_client).put_source(id=id, source=new_source)
# Below is a request that includes all optional parameters
@@ -2797,7 +2797,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Attribute 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.
@@ -2863,7 +2863,7 @@ with ApiClient(configuration) as api_client:
}''' # AttrSyncSourceConfig |
try:
# Update Attribute Sync Config
# Update attribute sync config
new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config)
results = SourcesApi(api_client).put_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental, attr_sync_source_config=new_attr_sync_source_config)
# Below is a request that includes all optional parameters
@@ -2879,7 +2879,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-source-schema
Update Source Schema (Full)
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
@@ -2936,7 +2936,7 @@ with ApiClient(configuration) as api_client:
model_schema = '''sailpoint.v2024.ModelSchema()''' # ModelSchema |
try:
# Update Source Schema (Full)
# Update source schema (full)
new_model_schema = ModelSchema.from_json(model_schema)
results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema)
# Below is a request that includes all optional parameters
@@ -3208,7 +3208,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-password-policy-holders
Update Password Policy
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.
@@ -3255,7 +3255,7 @@ with ApiClient(configuration) as api_client:
password_policy_holders_dto_inner = '''[sailpoint.v2024.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] |
try:
# Update Password Policy
# Update password policy
new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner.from_json(password_policy_holders_dto_inner)
results = SourcesApi(api_client).update_password_policy_holders(source_id=source_id, password_policy_holders_dto_inner=new_password_policy_holders_dto_inner)
# Below is a request that includes all optional parameters
@@ -3272,7 +3272,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-provisioning-policies-in-bulk
Bulk Update Provisioning Policies
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)
@@ -3317,7 +3317,7 @@ with ApiClient(configuration) as api_client:
provisioning_policy_dto = '''[sailpoint.v2024.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] |
try:
# Bulk Update Provisioning Policies
# Bulk update provisioning policies
new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto)
results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto)
# Below is a request that includes all optional parameters
@@ -3334,7 +3334,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-provisioning-policy
Partial update of 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.
@@ -3385,7 +3385,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
try:
# Partial update of Provisioning Policy
# Partial update of provisioning policy
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -3401,7 +3401,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-source
Update Source (Partial)
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.
@@ -3462,7 +3462,7 @@ with ApiClient(configuration) as api_client:
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)
# Update source (partial)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -3489,7 +3489,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Source Entitlement Request Configuration
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.
@@ -3560,7 +3560,7 @@ with ApiClient(configuration) as api_client:
}''' # SourceEntitlementRequestConfig |
try:
# Update Source Entitlement Request Configuration
# Update source entitlement request configuration
new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config)
results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental, source_entitlement_request_config=new_source_entitlement_request_config)
# Below is a request that includes all optional parameters
@@ -3576,7 +3576,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-source-schedule
Update Source Schedule (Partial)
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:
@@ -3629,7 +3629,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule.
try:
# Update Source Schedule (Partial)
# Update source schedule (partial)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SourcesApi(api_client).update_source_schedule(source_id=source_id, schedule_type=schedule_type, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -3645,7 +3645,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-source-schema
Update Source Schema (Partial)
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:
@@ -3722,7 +3722,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
try:
# Update Source Schema (Partial)
# Update source schema (partial)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

42
docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md
View File

@@ -18,17 +18,17 @@ 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**](#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
'Submit Sed Batch Stats Request.
Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
@@ -75,7 +75,7 @@ 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
# Submit sed batch stats request
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id)
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sed-batches
List Sed Batch Request
List sed batch request
List Sed Batches.
API responses with Sed Batch Status
@@ -131,7 +131,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Sed Batch Request
# List sed batch request
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
# Below is a request that includes all optional parameters
@@ -147,7 +147,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-seds
List Suggested Entitlement Descriptions
List suggested entitlement descriptions
List of Suggested Entitlement Descriptions (SED)
SED field descriptions:
@@ -218,7 +218,7 @@ with ApiClient(configuration) as api_client:
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
# List suggested entitlement descriptions
results = SuggestedEntitlementDescriptionApi(api_client).list_seds()
# Below is a request that includes all optional parameters
@@ -235,7 +235,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-sed
Patch Suggested Entitlement Description
Patch suggested entitlement description
Patch Suggested Entitlement Description
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed)
@@ -281,7 +281,7 @@ with ApiClient(configuration) as api_client:
sed_patch = '''[sailpoint.v2024.SedPatch()]''' # List[SedPatch] | Sed Patch Request
try:
# Patch Suggested Entitlement Description
# Patch suggested entitlement description
new_sed_patch = SedPatch.from_json(sed_patch)
results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch)
# Below is a request that includes all optional parameters
@@ -297,7 +297,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-approval
Submit Bulk Approval Request
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
@@ -342,7 +342,7 @@ with ApiClient(configuration) as api_client:
sed_approval = '''[sailpoint.v2024.SedApproval()]''' # List[SedApproval] | Sed Approval
try:
# Submit Bulk Approval Request
# Submit bulk approval request
new_sed_approval = SedApproval.from_json(sed_approval)
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval)
# Below is a request that includes all optional parameters
@@ -359,7 +359,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-assignment
Submit Sed Assignment Request
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
@@ -410,7 +410,7 @@ with ApiClient(configuration) as api_client:
}''' # SedAssignment | Sed Assignment Request
try:
# Submit Sed Assignment Request
# Submit sed assignment request
new_sed_assignment = SedAssignment.from_json(sed_assignment)
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment)
# Below is a request that includes all optional parameters
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-batch-request
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
@@ -474,7 +474,7 @@ with ApiClient(configuration) as api_client:
}''' # SedBatchRequest | Sed Batch Request (optional)
try:
# Submit Sed Batch Request
# Submit sed batch request
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request()
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md
View File

@@ -68,18 +68,18 @@ 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-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 object tags
Delete all tags from a tagged object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tagged-object)
@@ -122,7 +122,7 @@ with ApiClient(configuration) as api_client:
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
# Delete object tags
TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id)
# Below is a request that includes all optional parameters
@@ -136,7 +136,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-tags-to-many-object
Remove Tags from Multiple Objects
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)
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Remove Tags from Multiple Objects
# Remove tags from multiple objects
new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object)
# Below is a request that includes all optional parameters
@@ -203,7 +203,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-tagged-object
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)
@@ -247,7 +247,7 @@ 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 Tagged Object
# Get tagged object
results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id)
# Below is a request that includes all optional parameters
@@ -263,7 +263,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-tagged-objects
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.
@@ -313,7 +313,7 @@ with ApiClient(configuration) as api_client:
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
# List tagged objects
results = TaggedObjectsApi(api_client).list_tagged_objects()
# Below is a request that includes all optional parameters
@@ -330,7 +330,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-tagged-objects-by-type
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.
@@ -382,7 +382,7 @@ with ApiClient(configuration) as api_client:
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
# List tagged objects by type
results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type)
# Below is a request that includes all optional parameters
@@ -399,7 +399,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-tagged-object
Update 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)
@@ -452,7 +452,7 @@ with ApiClient(configuration) as api_client:
}''' # TaggedObject |
try:
# Update Tagged Object
# Update tagged object
new_tagged_object = TaggedObject.from_json(tagged_object)
results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object)
# Below is a request that includes all optional parameters
@@ -468,7 +468,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-tag-to-object
Add Tag to Object
Add tag to object
This adds a tag to an object.
Any authenticated token may be used to call this API.
@@ -519,7 +519,7 @@ with ApiClient(configuration) as api_client:
}''' # TaggedObject |
try:
# Add Tag to Object
# Add tag to object
new_tagged_object = TaggedObject.from_json(tagged_object)
TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object)
# Below is a request that includes all optional parameters
@@ -533,7 +533,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-tags-to-many-objects
Tag Multiple 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)
@@ -588,7 +588,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Tag Multiple Objects
# Tag multiple objects
new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object)
results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object)
# Below is a request that includes all optional parameters

30
docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md
View File

@@ -15,11 +15,11 @@ 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**](#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
@@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Retrieve Pending Task List 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/v2024/get-pending-task-headers)
@@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Retrieve pending task list headers
TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -108,7 +108,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Retrieve Pending Task Status List
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)
@@ -158,7 +158,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Retrieve pending task status list
results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -186,7 +186,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Task Status by ID
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)
@@ -232,7 +232,7 @@ 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 Task Status by ID
# Get task status by id
results = TaskManagementApi(api_client).get_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -259,7 +259,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Retrieve 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/v2024/get-pending-tasks) endpoint.
@@ -314,7 +314,7 @@ with ApiClient(configuration) as api_client:
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
# Retrieve task status list
results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -342,7 +342,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Task Status by ID
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)
@@ -391,7 +391,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
try:
# Update Task Status by ID
# Update task status by id
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = TaskManagementApi(api_client).update_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md
View File

@@ -15,11 +15,11 @@ 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) | **GET** `/tenant` | Get tenant information.
## get-tenant
Get Tenant Information.
Get tenant information.
This rest endpoint can be used to retrieve tenant details.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant)
@@ -58,7 +58,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Tenant Information.
# Get tenant information.
results = TenantApi(api_client).get_tenant()
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md
View File

@@ -22,7 +22,7 @@ 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
[**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
@@ -148,7 +148,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-transform
Transform by ID
Transform by id
This API returns the transform specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-transform)
@@ -191,7 +191,7 @@ 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
# Transform by id
results = TransformsApi(api_client).get_transform(id=id)
# Below is a request that includes all optional parameters

60
docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md
View File

@@ -56,16 +56,16 @@ 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**](#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
@@ -80,7 +80,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Complete Trigger Invocation
Complete trigger invocation
Completes an invocation to a REQUEST_RESPONSE type trigger.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-trigger-invocation)
@@ -133,7 +133,7 @@ with ApiClient(configuration) as api_client:
}''' # CompleteInvocation |
try:
# Complete Trigger Invocation
# Complete trigger invocation
new_complete_invocation = CompleteInvocation.from_json(complete_invocation)
TriggersApi(api_client).complete_trigger_invocation(id=id, x_sail_point_experimental=x_sail_point_experimental, complete_invocation=new_complete_invocation)
# Below is a request that includes all optional parameters
@@ -158,7 +158,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create a 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
@@ -230,7 +230,7 @@ with ApiClient(configuration) as api_client:
}''' # SubscriptionPostRequest |
try:
# Create a Subscription
# Create a subscription
new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request)
results = TriggersApi(api_client).create_subscription(x_sail_point_experimental=x_sail_point_experimental, subscription_post_request=new_subscription_post_request)
# Below is a request that includes all optional parameters
@@ -257,7 +257,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete a Subscription
Delete a subscription
Deletes an existing subscription to a trigger.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-subscription)
@@ -302,7 +302,7 @@ 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:
# Delete a Subscription
# Delete a subscription
TriggersApi(api_client).delete_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -327,7 +327,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Subscriptions
List subscriptions
Gets a list of all trigger subscriptions.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-subscriptions)
@@ -380,7 +380,7 @@ with ApiClient(configuration) as api_client:
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
# List subscriptions
results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -408,7 +408,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Latest Invocation Statuses
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.
@@ -463,7 +463,7 @@ with ApiClient(configuration) as api_client:
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
# List latest invocation statuses
results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -491,7 +491,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Triggers
List triggers
Gets a list of triggers that are available in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-triggers)
@@ -544,7 +544,7 @@ with ApiClient(configuration) as api_client:
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
# List triggers
results = TriggersApi(api_client).list_triggers(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -572,7 +572,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Patch a 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**
@@ -623,7 +623,7 @@ with ApiClient(configuration) as api_client:
subscription_patch_request_inner = '''[sailpoint.v2024.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] |
try:
# Patch a Subscription
# Patch a subscription
new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner)
results = TriggersApi(api_client).patch_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_patch_request_inner=new_subscription_patch_request_inner)
# Below is a request that includes all optional parameters
@@ -650,7 +650,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Start a Test 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/v2024/start-test-trigger-invocation)
@@ -706,7 +706,7 @@ with ApiClient(configuration) as api_client:
}''' # TestInvocation |
try:
# Start a Test Invocation
# Start a test invocation
new_test_invocation = TestInvocation.from_json(test_invocation)
results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental=x_sail_point_experimental, test_invocation=new_test_invocation)
# Below is a request that includes all optional parameters
@@ -734,7 +734,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Validate a Subscription Filter
Validate a subscription filter
Validates a JSONPath filter expression against a provided mock input.
Request requires a security scope of:
@@ -786,7 +786,7 @@ with ApiClient(configuration) as api_client:
}''' # ValidateFilterInputDto |
try:
# Validate a Subscription Filter
# Validate a subscription filter
new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto)
results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental=x_sail_point_experimental, validate_filter_input_dto=new_validate_filter_input_dto)
# Below is a request that includes all optional parameters
@@ -813,7 +813,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update a 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:
@@ -894,7 +894,7 @@ with ApiClient(configuration) as api_client:
}''' # SubscriptionPutRequest |
try:
# Update a Subscription
# Update a subscription
new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request)
results = TriggersApi(api_client).update_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_put_request=new_subscription_put_request)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md
View File

@@ -16,8 +16,8 @@ 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**](#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
@@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get a tenant UI metadata
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)
@@ -76,7 +76,7 @@ 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
# Get a tenant ui metadata
results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -103,7 +103,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update 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.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tenant-ui-metadata)
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
}''' # TenantUiMetadataItemUpdateRequest |
try:
# Update tenant UI metadata
# Update tenant ui metadata
new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request)
results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental, tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md
View File

@@ -19,13 +19,13 @@ 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) | **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 vendor connector mapping
Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
}''' # VendorConnectorMapping |
try:
# Create Vendor Connector Mapping
# Create vendor connector mapping
new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping)
results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
@@ -107,7 +107,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-vendor-connector-mapping
Delete Vendor Connector Mapping
Delete vendor connector mapping
Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
@@ -174,7 +174,7 @@ with ApiClient(configuration) as api_client:
}''' # VendorConnectorMapping |
try:
# Delete Vendor Connector Mapping
# Delete vendor connector mapping
new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping)
results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
@@ -190,7 +190,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-vendor-connector-mappings
List Vendor Connector Mappings
List vendor connector mappings
Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
@@ -230,7 +230,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Vendor Connector Mappings
# List vendor connector mappings
results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
# Below is a request that includes all optional parameters

78
docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md
View File

@@ -29,23 +29,23 @@ 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-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
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)
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Approve an Approval Item
# Approve an approval item
results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## approve-approval-items-in-bulk
Bulk approve Approval Items
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)
@@ -149,7 +149,7 @@ 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
# Bulk approve approval items
results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## complete-work-item
Complete a 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)
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional)
try:
# Complete a Work Item
# Complete a work item
results = WorkItemsApi(api_client).complete_work_item(id=id)
# Below is a request that includes all optional parameters
@@ -237,7 +237,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Forward a 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/v2024/forward-work-item)
@@ -288,7 +288,7 @@ with ApiClient(configuration) as api_client:
}''' # WorkItemForward |
try:
# Forward a Work Item
# Forward a work item
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
@@ -302,7 +302,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-completed-work-items
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)
@@ -350,7 +350,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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
# Completed work items
results = WorkItemsApi(api_client).get_completed_work_items()
# Below is a request that includes all optional parameters
@@ -378,7 +378,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/get-count-completed-work-items)
@@ -421,7 +421,7 @@ 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
# Count completed work items
results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -437,7 +437,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-count-work-items
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)
@@ -479,7 +479,7 @@ 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
# Count work items
results = WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
@@ -495,7 +495,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-work-item
Get a 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)
@@ -537,7 +537,7 @@ 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
# Get a work item
results = WorkItemsApi(api_client).get_work_item(id=id)
# Below is a request that includes all optional parameters
@@ -553,7 +553,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-work-items-summary
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)
@@ -595,7 +595,7 @@ 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
# Work items summary
results = WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
@@ -611,7 +611,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-work-items
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)
@@ -659,7 +659,7 @@ 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:
# List Work Items
# List work items
results = WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
@@ -676,7 +676,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval-item
Reject an 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)
@@ -721,7 +721,7 @@ with ApiClient(configuration) as api_client:
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Reject an Approval Item
# Reject an approval item
results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
@@ -737,7 +737,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval-items-in-bulk
Bulk reject Approval Items
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)
@@ -780,7 +780,7 @@ 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
# Bulk reject approval items
results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
@@ -796,7 +796,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-account-selection
Submit Account Selections
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)
@@ -841,7 +841,7 @@ with ApiClient(configuration) as api_client:
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
# Submit account selections
new_request_body = RequestBody.from_json(request_body)
results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters

54
docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md
View File

@@ -25,15 +25,15 @@ 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**](#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
@@ -48,7 +48,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Create a Reassignment Configuration
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)
@@ -100,7 +100,7 @@ with ApiClient(configuration) as api_client:
}''' # ConfigurationItemRequest |
try:
# Create a Reassignment Configuration
# Create a reassignment configuration
new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request)
results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request)
# Below is a request that includes all optional parameters
@@ -127,7 +127,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Delete Reassignment Configuration
Delete reassignment configuration
Deletes a single reassignment configuration for the specified identity
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-reassignment-configuration)
@@ -174,7 +174,7 @@ 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:
# Delete Reassignment Configuration
# Delete reassignment configuration
WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -199,7 +199,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
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/v2024/get-evaluate-reassignment-configuration)
@@ -249,7 +249,7 @@ with ApiClient(configuration) as api_client:
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
# Evaluate reassignment configuration
results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -277,7 +277,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List 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/v2024/get-reassignment-config-types)
@@ -320,7 +320,7 @@ 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
# List reassignment config types
results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -348,7 +348,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Reassignment Configuration
Get reassignment configuration
Gets the Reassignment Configuration for an identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-configuration)
@@ -394,7 +394,7 @@ 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 Reassignment Configuration
# Get reassignment configuration
results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -421,7 +421,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Get Tenant-wide Reassignment Configuration settings
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)
@@ -465,7 +465,7 @@ 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
# Get tenant-wide reassignment configuration settings
results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -492,7 +492,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Reassignment Configurations
List reassignment configurations
Gets all Reassignment configuration for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-reassignment-configurations)
@@ -536,7 +536,7 @@ 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
# List reassignment configurations
results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -564,7 +564,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Reassignment Configuration
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)
@@ -618,7 +618,7 @@ with ApiClient(configuration) as api_client:
}''' # ConfigurationItemRequest |
try:
# Update Reassignment Configuration
# Update reassignment configuration
new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request)
results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request)
# Below is a request that includes all optional parameters
@@ -645,7 +645,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update Tenant-wide Reassignment Configuration settings
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)
@@ -695,7 +695,7 @@ with ApiClient(configuration) as api_client:
}''' # TenantConfigurationRequest |
try:
# Update Tenant-wide Reassignment Configuration settings
# Update tenant-wide reassignment configuration settings
new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request)
results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request)
# Below is a request that includes all optional parameters

108
docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md
View File

@@ -16,28 +16,28 @@ 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) | **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
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)
@@ -79,7 +79,7 @@ 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
# Cancel workflow execution by id
WorkflowsApi(api_client).cancel_workflow_execution(id=id)
# Below is a request that includes all optional parameters
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-external-execute-workflow
Execute Workflow via External Trigger
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)
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
# Execute workflow via external trigger
results = WorkflowsApi(api_client).create_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-workflow
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)
@@ -197,7 +197,7 @@ 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
# Create workflow
new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request)
results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request)
# Below is a request that includes all optional parameters
@@ -213,7 +213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-workflow-external-trigger
Generate External Trigger OAuth Client
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)
@@ -255,7 +255,7 @@ 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
# Generate external trigger oauth client
results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id)
# Below is a request that includes all optional parameters
@@ -271,7 +271,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-workflow
Delete Workflow By Id
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)
@@ -312,7 +312,7 @@ 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
# Delete workflow by id
WorkflowsApi(api_client).delete_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -326,7 +326,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workflow
Get Workflow By Id
Get workflow by id
Get a single workflow by id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow)
@@ -368,7 +368,7 @@ 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
# Get workflow by id
results = WorkflowsApi(api_client).get_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -384,7 +384,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workflow-execution
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)
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID.
try:
# Get Workflow Execution
# Get workflow execution
results = WorkflowsApi(api_client).get_workflow_execution(id=id)
# Below is a request that includes all optional parameters
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workflow-execution-history
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)
@@ -485,7 +485,7 @@ 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
# Get workflow execution history
results = WorkflowsApi(api_client).get_workflow_execution_history(id=id)
# Below is a request that includes all optional parameters
@@ -502,7 +502,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workflow-executions
List 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.
@@ -563,7 +563,7 @@ with ApiClient(configuration) as api_client:
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
# List workflow executions
results = WorkflowsApi(api_client).get_workflow_executions(id=id)
# Below is a request that includes all optional parameters
@@ -580,7 +580,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-complete-workflow-library
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)
@@ -624,7 +624,7 @@ 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)
try:
# List Complete Workflow Library
# List complete workflow library
results = WorkflowsApi(api_client).list_complete_workflow_library()
# Below is a request that includes all optional parameters
@@ -641,7 +641,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-workflow-library-actions
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)
@@ -687,7 +687,7 @@ with ApiClient(configuration) as api_client:
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
# List workflow library actions
results = WorkflowsApi(api_client).list_workflow_library_actions()
# Below is a request that includes all optional parameters
@@ -704,7 +704,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-workflow-library-operators
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)
@@ -742,7 +742,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflow Library Operators
# List workflow library operators
results = WorkflowsApi(api_client).list_workflow_library_operators()
# Below is a request that includes all optional parameters
@@ -759,7 +759,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-workflow-library-triggers
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)
@@ -805,7 +805,7 @@ with ApiClient(configuration) as api_client:
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
# List workflow library triggers
results = WorkflowsApi(api_client).list_workflow_library_triggers()
# Below is a request that includes all optional parameters
@@ -822,7 +822,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-workflows
List Workflows
List workflows
List all workflows in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflows)
@@ -860,7 +860,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflows
# List workflows
results = WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
@@ -877,7 +877,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-workflow
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)
@@ -922,7 +922,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] |
try:
# Patch Workflow
# Patch workflow
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -938,7 +938,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-workflow
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/v2024/put-workflow)
@@ -1022,7 +1022,7 @@ with ApiClient(configuration) as api_client:
}''' # WorkflowBody |
try:
# Update Workflow
# Update workflow
new_workflow_body = WorkflowBody.from_json(workflow_body)
results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body)
# Below is a request that includes all optional parameters
@@ -1038,7 +1038,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-external-execute-workflow
Test Workflow via External Trigger
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)
@@ -1083,7 +1083,7 @@ with ApiClient(configuration) as api_client:
test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional)
try:
# Test Workflow via External Trigger
# Test workflow via external trigger
results = WorkflowsApi(api_client).test_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -1099,7 +1099,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-workflow
Test Workflow By Id
Test workflow by id
:::info
Workflow must be disabled in order to use this endpoint.
@@ -1155,7 +1155,7 @@ with ApiClient(configuration) as api_client:
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
# Test workflow by id
new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request)
results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request)
# Below is a request that includes all optional parameters