LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +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/Beta/Methods/AccessModelMetadataApi.md
View File

@@ -25,14 +25,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute
[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value
[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes
[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values
[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **GET** `/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 attribute
Get single Access Model Metadata Attribute
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute)
@@ -74,7 +74,7 @@ with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
try:
# Get Access Model Metadata Attribute
# Get access model metadata attribute
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key)
# Below is a request that includes all optional parameters
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-model-metadata-attribute-value
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/beta/get-access-model-metadata-attribute-value)
@@ -134,7 +134,7 @@ with ApiClient(configuration) as api_client:
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
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)
# Below is a request that includes all optional parameters
@@ -150,7 +150,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-model-metadata-attribute
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/beta/list-access-model-metadata-attribute)
@@ -192,7 +192,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()
# Below is a request that includes all optional parameters
@@ -209,7 +209,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-model-metadata-attribute-value
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/beta/list-access-model-metadata-attribute-value)
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
try:
# List Access Model Metadata Values
# List access model metadata values
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key)
# Below is a request that includes all optional parameters

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

@@ -49,18 +49,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile
[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile
[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s)
[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile
[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements
[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field.
[**create-access-profile**](#create-access-profile) | **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.
@@ -315,7 +315,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
@@ -331,7 +331,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/beta/get-access-profile)
@@ -373,7 +373,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
@@ -389,7 +389,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 user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
@@ -442,7 +442,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
@@ -459,7 +459,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.
@@ -516,7 +516,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
@@ -533,7 +533,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**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.
@@ -583,7 +583,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
@@ -599,7 +599,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-access-profiles-in-bulk
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**
@@ -649,7 +649,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(access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md
View File

@@ -32,16 +32,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-access-request**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval
[**forward-access-request**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval
[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number
[**list-completed-approvals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List
[**list-pending-approvals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**reject-access-request**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
[**approve-access-request**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve access request approval
[**forward-access-request**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward access request approval
[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get access requests approvals number
[**list-completed-approvals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed access request approvals list
[**list-pending-approvals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending access request approvals list
[**reject-access-request**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject access request approval
## approve-access-request
Approve Access Request Approval
Approve access request approval
Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-access-request)
@@ -94,7 +94,7 @@ with ApiClient(configuration) as api_client:
}''' # CommentDto | Reviewer's comment.
try:
# Approve Access Request Approval
# Approve access request approval
new_comment_dto = CommentDto.from_json(comment_dto)
results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id, comment_dto=new_comment_dto)
# Below is a request that includes all optional parameters
@@ -110,7 +110,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-access-request)
@@ -158,7 +158,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
@@ -174,7 +174,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-approval-summary)
@@ -218,7 +218,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
@@ -234,7 +234,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/beta/list-completed-approvals)
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
try:
# Completed Access Request Approvals List
# Completed access request approvals list
results = AccessRequestApprovalsApi(api_client).list_completed_approvals()
# Below is a request that includes all optional parameters
@@ -302,7 +302,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/beta/list-pending-approvals)
@@ -353,7 +353,7 @@ with ApiClient(configuration) as api_client:
sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
try:
# Pending Access Request Approvals List
# Pending access request approvals list
results = AccessRequestApprovalsApi(api_client).list_pending_approvals()
# Below is a request that includes all optional parameters
@@ -370,7 +370,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/beta/reject-access-request)
@@ -423,7 +423,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

36
docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md
View File

@@ -30,16 +30,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request
[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request
[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close access request
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit access request
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration
## cancel-access-request
Cancel Access Request
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.
@@ -86,7 +86,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
@@ -102,7 +102,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## close-access-request
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.
@@ -160,7 +160,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(close_access_request=new_close_access_request)
# Below is a request that includes all optional parameters
@@ -176,7 +176,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
@@ -434,7 +434,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
@@ -450,7 +450,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/beta/get-access-request-config)
@@ -488,7 +488,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
@@ -504,7 +504,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.
@@ -566,7 +566,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
@@ -583,7 +583,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/beta/set-access-request-config)
@@ -650,7 +650,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/Beta/Methods/AccountActivitiesApi.md
View File

@@ -48,12 +48,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity
[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get account activity
[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List account activities
## get-account-activity
Get Account Activity
Get account activity
This gets a single account activity by its id.
[API Spec](https://developer.sailpoint.com/docs/api/beta/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 Account Activity
# Get 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/beta/list-account-activities)
@@ -170,7 +170,7 @@ with ApiClient(configuration) as api_client:
sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional)
try:
# List Account Activities
# 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/Beta/Methods/AccountAggregationsApi.md
View File

@@ -25,11 +25,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-account-aggregation-status**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status
[**get-account-aggregation-status**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status
## get-account-aggregation-status
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.
@@ -79,7 +79,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id
try:
# In-progress Account Aggregation status
# In-progress account aggregation status
results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id)
# Below is a request that includes all optional parameters

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

@@ -42,29 +42,29 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-account**](#create-account) | **POST** `/accounts` | Create Account
[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account
[**delete-account-async**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account
[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account
[**disable-account-for-identity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity
[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities
[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account
[**enable-account-for-identity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity
[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities
[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account Details
[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements
[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts List
[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update Account
[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account
[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
[**create-account**](#create-account) | **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
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create Account
Create account
Submits an account creation task - the API then returns the task ID.
The `sourceId` where this account will be created must be included in the `attributes` object.
@@ -127,7 +127,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
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -193,7 +193,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
@@ -209,7 +209,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-account-async
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:
@@ -257,7 +257,7 @@ with ApiClient(configuration) as api_client:
id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id
try:
# Remove Account
# Remove account
results = AccountsApi(api_client).delete_account_async(id=id)
# Below is a request that includes all optional parameters
@@ -276,7 +276,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable Account
Disable account
This API submits a task to disable the account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -326,7 +326,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
@@ -345,7 +345,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/disable-account-for-identity)
@@ -387,7 +387,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
try:
# Disable IDN Account for Identity
# Disable idn account for identity
results = AccountsApi(api_client).disable_account_for_identity(id=id)
# Below is a request that includes all optional parameters
@@ -406,7 +406,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/disable-accounts-for-identities)
@@ -451,7 +451,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(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
@@ -471,7 +471,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable Account
Enable account
This API submits a task to enable account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -521,7 +521,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
@@ -540,7 +540,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/enable-account-for-identity)
@@ -582,7 +582,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
try:
# Enable IDN Account for Identity
# Enable idn account for identity
results = AccountsApi(api_client).enable_account_for_identity(id=id)
# Below is a request that includes all optional parameters
@@ -601,7 +601,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/enable-accounts-for-identities)
@@ -646,7 +646,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(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
@@ -666,7 +666,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Details
Account details
Use this API to return the details for a single account by its ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -710,7 +710,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
@@ -729,7 +729,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Entitlements
Account entitlements
This API returns entitlements of the account.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -779,7 +779,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
@@ -799,7 +799,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Accounts List
Accounts list
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts)
@@ -851,7 +851,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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional)
try:
# Accounts List
# Accounts list
results = AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
@@ -871,7 +871,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -932,7 +932,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
@@ -951,7 +951,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Reload Account
Reload account
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -995,7 +995,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
@@ -1014,7 +1014,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Unlock Account
Unlock account
This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -1066,7 +1066,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
@@ -1085,7 +1085,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account
Update account
Use this API to update account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -1140,7 +1140,7 @@ with ApiClient(configuration) as api_client:
request_body = '''{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Account
# 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

24
docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md
View File

@@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-discovered-application-by-id**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get Discovered Application by ID
[**get-discovered-application-by-id**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get discovered application by id
[**get-discovered-applications**](#get-discovered-applications) | **GET** `/discovered-applications` | Retrieve discovered applications for tenant
[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**patch-discovered-application-by-id**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID
[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery
[**patch-discovered-application-by-id**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch discovered application by id
[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications
## get-discovered-application-by-id
Get Discovered Application by ID
Get discovered application by id
Get the discovered application, along with with its associated sources, based on the provided ID.
@@ -67,7 +67,7 @@ with ApiClient(configuration) as api_client:
id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID.
try:
# Get Discovered Application by ID
# Get discovered application by id
ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -149,7 +149,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.
@@ -190,7 +190,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
@@ -206,7 +206,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-discovered-application-by-id
Patch Discovered Application by ID
Patch discovered application by id
Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
You can patch these fields: - **associatedSources** - **dismissed**
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
json_patch_operations = '''[{op=replace, path=/dismissed, value=true}]''' # List[JsonPatchOperations] | (optional)
try:
# Patch Discovered Application by ID
# Patch discovered application by id
ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -265,7 +265,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
Upload a CSV file with application data for manual correlation to specific ISC connectors.
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
@@ -307,7 +307,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

12
docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md
View File

@@ -18,12 +18,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval
[**get-approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals
[**get-approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get approval
[**get-approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
## get-approval
Get Approval
Get approval
Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval)
@@ -65,7 +65,7 @@ with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned.
try:
# Get Approval
# Get approval
results = ApprovalsApi(api_client).get_approval(id=id)
# Below is a request that includes all optional parameters
@@ -81,7 +81,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-approvals
Get Approvals
Get approvals
Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals.
Absence of all query parameters will will default to mine=true.
@@ -128,7 +128,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()
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/Beta/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
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-source-app
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/beta/delete-source-app)
@@ -207,7 +207,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID.
try:
# Delete source app by ID
# Delete source app by id
results = AppsApi(api_client).delete_source_app(id=id)
# Below is a request that includes all optional parameters
@@ -223,7 +223,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-app
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/beta/get-source-app)
@@ -266,7 +266,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
try:
# Get source app by ID
# Get source app by id
results = AppsApi(api_client).get_source_app(id=id)
# Below is a request that includes all optional parameters
@@ -746,7 +746,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-source-app
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.
@@ -794,7 +794,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)
# Below is a request that includes all optional parameters
@@ -810,7 +810,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-user-app
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**
@@ -857,7 +857,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional)
try:
# Patch user app by ID
# Patch user app by id
results = AppsApi(api_client).patch_user_app(id=id)
# Below is a request that includes all optional parameters

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

@@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-profile-config**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile.
[**get-profile-config-list**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
[**patch-profile-config**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
[**get-profile-config**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get auth profile.
[**get-profile-config-list**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of auth profiles.
[**patch-profile-config**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified auth profile
## get-profile-config
Get Auth Profile.
Get auth profile.
This API returns auth profile information.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config)
@@ -70,7 +70,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get.
try:
# Get Auth Profile.
# Get auth profile.
results = AuthProfileApi(api_client).get_profile_config(id=id)
# Below is a request that includes all optional parameters
@@ -86,7 +86,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-profile-config-list
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/beta/get-profile-config-list)
@@ -124,7 +124,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get list of Auth Profiles.
# Get list of auth profiles.
results = AuthProfileApi(api_client).get_profile_config_list()
# Below is a request that includes all optional parameters
@@ -141,7 +141,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-profile-config
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**
@@ -187,7 +187,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.beta.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, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

132
docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md
View File

@@ -80,35 +80,35 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign
[**create-campaign**](#create-campaign) | **POST** `/campaigns` | Create Campaign
[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template
[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template
[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule
[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns
[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns
[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign
[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports
[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration
[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template
[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule
[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates
[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications
[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template
[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration
[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule
[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign
[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan
[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report
[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign
[**create-campaign**](#create-campaign) | **POST** `/campaigns` | Create campaign
[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template
[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template
[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule
[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns
[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns
[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign
[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports
[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration
[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template
[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule
[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates
[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications
[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template
[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration
[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule
[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign
[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan
[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report
[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template
[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign
## complete-campaign
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Complete a Campaign
Complete a campaign
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
}''' # CompleteCampaignOptions | 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
@@ -186,7 +186,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create Campaign
Create campaign
Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -339,7 +339,7 @@ with ApiClient(configuration) as api_client:
}''' # Campaign |
try:
# Create Campaign
# Create campaign
new_campaign = Campaign.from_json(campaign)
results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign)
# Below is a request that includes all optional parameters
@@ -358,7 +358,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create a Campaign Template
Create a campaign template
Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -526,7 +526,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
@@ -545,7 +545,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete a Campaign Template
Delete a campaign template
Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -590,7 +590,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
@@ -607,7 +607,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -652,7 +652,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
@@ -669,7 +669,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete Campaigns
Delete campaigns
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -717,7 +717,7 @@ with ApiClient(configuration) as api_client:
}''' # DeleteCampaignsRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
# Delete campaigns
new_delete_campaigns_request = DeleteCampaignsRequest.from_json(delete_campaigns_request)
results = CertificationCampaignsApi(api_client).delete_campaigns(delete_campaigns_request=new_delete_campaigns_request)
# Below is a request that includes all optional parameters
@@ -736,7 +736,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List Campaigns
List campaigns
Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -791,7 +791,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
@@ -811,7 +811,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get Campaign
Get campaign
Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -857,7 +857,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved.
try:
# Get Campaign
# Get campaign
results = CertificationCampaignsApi(api_client).get_campaign(id=id)
# Below is a request that includes all optional parameters
@@ -876,7 +876,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get Campaign Reports
Get campaign reports
Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -922,7 +922,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
@@ -942,7 +942,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -983,7 +983,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
@@ -1002,7 +1002,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a Campaign Template
Get a campaign template
Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1048,7 +1048,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
@@ -1067,7 +1067,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1113,7 +1113,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
@@ -1132,7 +1132,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates).
The endpoint returns all campaign templates matching the query parameters.
@@ -1187,7 +1187,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
@@ -1207,7 +1207,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Reassign Certifications
Reassign certifications
This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1263,7 +1263,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
@@ -1282,7 +1282,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1331,7 +1331,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
@@ -1350,7 +1350,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Set Campaign Reports Configuration
Set campaign reports configuration
Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1397,7 +1397,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
@@ -1416,7 +1416,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule).
@@ -1484,7 +1484,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
@@ -1501,7 +1501,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1551,7 +1551,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
@@ -1570,7 +1570,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Run Campaign Remediation Scan
Run campaign remediation scan
Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -1615,7 +1615,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
@@ -1634,7 +1634,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Run Campaign Report
Run campaign report
Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -1682,7 +1682,7 @@ with ApiClient(configuration) as api_client:
type = sailpoint.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of 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
@@ -1701,7 +1701,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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
@@ -1758,7 +1758,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
@@ -1777,7 +1777,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1825,7 +1825,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[object] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
try:
# Update a Campaign
# Update a campaign
new_request_body = RequestBody.from_json(request_body)
results = CertificationCampaignsApi(api_client).update_campaign(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters

36
docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md
View File

@@ -30,19 +30,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item
[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks
[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status
[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**list-certifications**](#list-certifications) | **GET** `/certifications` | Certifications by IDs
[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item
[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending certification tasks
[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification task status
[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification
[**list-certifications**](#list-certifications) | **GET** `/certifications` | Certifications by ids
[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously
## get-identity-certification-item-permissions
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Permissions for Entitlement Certification Item
Permissions for entitlement certification item
This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-item-permissions)
@@ -95,7 +95,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
@@ -112,7 +112,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-certification-pending-tasks
Pending Certification Tasks
Pending certification tasks
This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-pending-tasks)
@@ -155,7 +155,7 @@ with ApiClient(configuration) as api_client:
id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID
try:
# Pending Certification Tasks
# Pending certification tasks
results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id=id)
# Below is a request that includes all optional parameters
@@ -172,7 +172,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-certification-task-status
Certification Task Status
Certification task status
This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-task-status)
@@ -217,7 +217,7 @@ with ApiClient(configuration) as api_client:
task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID
try:
# Certification Task Status
# Certification task status
results = CertificationsApi(api_client).get_identity_certification_task_status(id=id, task_id=task_id)
# Below is a request that includes all optional parameters
@@ -236,7 +236,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List of Reviewers for certification
List of reviewers for certification
This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certification-reviewers)
@@ -289,7 +289,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
@@ -306,7 +306,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-certifications
Certifications by IDs
Certifications by ids
This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certifications)
@@ -358,7 +358,7 @@ with ApiClient(configuration) as api_client:
sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional)
try:
# Certifications by IDs
# Certifications by ids
results = CertificationsApi(api_client).list_certifications()
# Below is a request that includes all optional parameters
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reassign-certs-async)
@@ -434,7 +434,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

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

@@ -21,16 +21,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-connector-rule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule
[**delete-connector-rule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a Connector-Rule
[**get-connector-rule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-Rule by ID
[**get-connector-rule-list**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules
[**update-connector-rule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule
[**validate-connector-rule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
[**create-connector-rule**](#create-connector-rule) | **POST** `/connector-rules` | Create connector rule
[**delete-connector-rule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a connector-rule
[**get-connector-rule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-rule by id
[**get-connector-rule-list**](#get-connector-rule-list) | **GET** `/connector-rules` | List connector rules
[**update-connector-rule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a connector rule
[**validate-connector-rule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate connector rule
## create-connector-rule
Create Connector Rule
Create connector rule
Creates a new connector rule.
A token with ORG_ADMIN authority is required to call this API.
@@ -99,7 +99,7 @@ with ApiClient(configuration) as api_client:
}''' # ConnectorRuleCreateRequest | The 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 a Connector-Rule
Delete a connector-rule
Deletes the connector rule specified by the given ID.
A token with ORG_ADMIN authority is required to call this API.
@@ -158,7 +158,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 a Connector-Rule
# Delete a connector-rule
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id)
# Below is a request that includes all optional parameters
@@ -172,7 +172,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-rule
Connector-Rule by ID
Connector-rule by id
Returns the connector rule specified by ID.
A token with ORG_ADMIN authority is required to call this API.
@@ -216,7 +216,7 @@ with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve
try:
# Connector-Rule by ID
# Connector-rule by id
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id)
# Below is a request that includes all optional parameters
@@ -232,7 +232,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-rule-list
List Connector Rules
List connector rules
Returns the list of connector rules.
A token with ORG_ADMIN authority is required to call this API.
@@ -271,7 +271,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Connector Rules
# List connector rules
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list()
# Below is a request that includes all optional parameters
@@ -288,7 +288,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-connector-rule
Update a Connector Rule
Update a connector rule
Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.
A token with ORG_ADMIN authority is required to call this API.
@@ -361,7 +361,7 @@ with ApiClient(configuration) as api_client:
}''' # ConnectorRuleUpdateRequest | The connector rule with updated data (optional)
try:
# Update a Connector Rule
# Update a connector rule
results = ConnectorRuleManagementApi(api_client).update_connector_rule(id=id)
# Below is a request that includes all optional parameters
@@ -377,7 +377,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## validate-connector-rule
Validate Connector Rule
Validate connector rule
Returns a list of issues within the code to fix, if any.
A token with ORG_ADMIN authority is required to call this API.
@@ -424,7 +424,7 @@ with ApiClient(configuration) as api_client:
}''' # SourceCode | The code to validate
try:
# Validate Connector Rule
# Validate connector rule
new_source_code = SourceCode.from_json(source_code)
results = ConnectorRuleManagementApi(api_client).validate_connector_rule(source_code=new_source_code)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md
View File

@@ -29,11 +29,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get Connector List
[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get connector list
## get-connector-list
Get Connector List
Get connector list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-list)
@@ -84,7 +84,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

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

@@ -25,15 +25,15 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create-form-definition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition.
[**create-form-definition-by-template**](#create-form-definition-by-template) | **POST** `/form-definitions/template` | Create a form definition by template.
[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically.
[**create-form-definition-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.
@@ -383,7 +383,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/beta/create-form-definition-dynamic-schema)
@@ -435,7 +435,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
@@ -717,7 +717,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/beta/get-file-from-s3)
@@ -762,7 +762,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
@@ -896,7 +896,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/beta/get-form-instance-file)
@@ -941,7 +941,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/Beta/Methods/CustomPasswordInstructionsApi.md
View File

@@ -26,13 +26,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-custom-password-instructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions
[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**get-custom-password-instructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
[**create-custom-password-instructions**](#create-custom-password-instructions) | **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
Create custom password instructions
This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions)
@@ -76,7 +76,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(custom_password_instruction=new_custom_password_instruction)
# Below is a request that includes all optional parameters
@@ -92,7 +92,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-custom-password-instructions
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. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-custom-password-instructions)
@@ -134,7 +134,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)
# Below is a request that includes all optional parameters
@@ -148,7 +148,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-custom-password-instructions
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. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-password-instructions)
@@ -191,7 +191,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)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/Beta/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/{sourceId}` | 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/{sourceId}` | Reset source entitlements
[**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list
@@ -259,7 +259,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-entitlement-request-config
Get Entitlement Request Config
Get entitlement request config
This API returns the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-request-config)
@@ -302,7 +302,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id
try:
# Get Entitlement Request Config
# Get entitlement request config
results = EntitlementsApi(api_client).get_entitlement_request_config(id=id)
# Below is a request that includes all optional parameters
@@ -321,7 +321,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -369,7 +369,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)
# Below is a request that includes all optional parameters
@@ -672,7 +672,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-entitlement-request-config
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/beta/put-entitlement-request-config)
@@ -739,7 +739,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, entitlement_request_config=new_entitlement_request_config)
# Below is a request that includes all optional parameters
@@ -755,7 +755,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reset-source-entitlements
Reset Source Entitlements
Reset source entitlements
Remove all entitlements from a specific source.
To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
@@ -798,7 +798,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset
try:
# Reset Source Entitlements
# Reset source entitlements
results = EntitlementsApi(api_client).reset_source_entitlements(source_id=source_id)
# Below is a request that includes all optional parameters

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

@@ -20,20 +20,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group.
[**delete-workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group
[**delete-workgroup-members**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group
[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s)
[**get-workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id
[**list-connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group
[**list-workgroup-members**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members
[**list-workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups
[**patch-workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**update-workgroup-members**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
[**create-workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new governance group.
[**delete-workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a governance group
[**delete-workgroup-members**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group
[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete governance group(s)
[**get-workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get governance group by id
[**list-connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for governance group
[**list-workgroup-members**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List governance group members
[**list-workgroups**](#list-workgroups) | **GET** `/workgroups` | List governance groups
[**patch-workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a governance group
[**update-workgroup-members**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group
## create-workgroup
Create a new Governance Group.
Create a new governance group.
This API creates a new Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workgroup)
@@ -90,7 +90,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(workgroup_dto=new_workgroup_dto)
# Below is a request that includes all optional parameters
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-workgroup
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/beta/delete-workgroup)
@@ -147,7 +147,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
try:
# Delete a Governance Group
# Delete a governance group
GovernanceGroupsApi(api_client).delete_workgroup(id=id)
# Below is a request that includes all optional parameters
@@ -161,7 +161,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-workgroup-members
Remove members from Governance Group
Remove members from governance group
This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
> **Following field of Identity is an optional field in the request.**
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list.
try:
# Remove members from Governance Group
# Remove members from governance group
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner.from_json(bulk_workgroup_members_request_inner)
results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, bulk_workgroup_members_request_inner=new_bulk_workgroup_members_request_inner)
# Below is a request that includes all optional parameters
@@ -227,7 +227,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-workgroups-in-bulk
Delete Governance Group(s)
Delete governance group(s)
This API initiates a bulk deletion of one or more Governance Groups.
@@ -283,7 +283,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(workgroup_bulk_delete_request=new_workgroup_bulk_delete_request)
# Below is a request that includes all optional parameters
@@ -300,7 +300,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workgroup
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/beta/get-workgroup)
@@ -342,7 +342,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
try:
# Get Governance Group by Id
# Get governance group by id
results = GovernanceGroupsApi(api_client).get_workgroup(id=id)
# Below is a request that includes all optional parameters
@@ -358,7 +358,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-connections
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/beta/list-connections)
@@ -408,7 +408,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)
# Below is a request that includes all optional parameters
@@ -425,7 +425,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-workgroup-members
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/beta/list-workgroup-members)
@@ -475,7 +475,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)
# Below is a request that includes all optional parameters
@@ -492,7 +492,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-workgroups
List Governance Groups
List governance groups
This API returns list of Governance Groups
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroups)
@@ -542,7 +542,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()
# Below is a request that includes all optional parameters
@@ -559,7 +559,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-workgroup
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
@@ -610,7 +610,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)
# Below is a request that includes all optional parameters
@@ -626,7 +626,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-workgroup-members
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.**
@@ -675,7 +675,7 @@ with ApiClient(configuration) as api_client:
bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list.
try:
# Add members to Governance Group
# Add members to governance group
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner.from_json(bulk_workgroup_members_request_inner)
results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, bulk_workgroup_members_request_inner=new_bulk_workgroup_members_request_inner)
# Below is a request that includes all optional parameters

48
docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md
View File

@@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | 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-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
[**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-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
## add-access-request-recommendations-ignored-item
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/beta/add-access-request-recommendations-ignored-item)
@@ -75,7 +75,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(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-requested-item
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/beta/add-access-request-recommendations-requested-item)
@@ -140,7 +140,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(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -156,7 +156,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-viewed-item
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/beta/add-access-request-recommendations-viewed-item)
@@ -205,7 +205,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(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -221,7 +221,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-viewed-items
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/beta/add-access-request-recommendations-viewed-items)
@@ -264,7 +264,7 @@ with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = '''[sailpoint.beta.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(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -281,7 +281,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations
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/beta/get-access-request-recommendations)
@@ -335,7 +335,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()
# Below is a request that includes all optional parameters
@@ -352,7 +352,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
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/beta/get-access-request-recommendations-ignored-items)
@@ -402,7 +402,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()
# Below is a request that includes all optional parameters
@@ -419,7 +419,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-requested-items
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/beta/get-access-request-recommendations-requested-items)
@@ -469,7 +469,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()
# Below is a request that includes all optional parameters
@@ -486,7 +486,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-viewed-items
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/beta/get-access-request-recommendations-viewed-items)
@@ -536,7 +536,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()
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md
View File

@@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-message-catalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs
[**get-message-catalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get message catalogs
## get-message-catalogs
Get Message catalogs
Get message catalogs
The getMessageCatalogs API returns message catalog based on the language headers in the requested object.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-message-catalogs)
@@ -61,7 +61,7 @@ with ApiClient(configuration) as api_client:
catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog.
try:
# Get Message catalogs
# Get message catalogs
results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id=catalog_id)
# Below is a request that includes all optional parameters

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

@@ -15,19 +15,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**export-outliers-zip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export
[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary
[**get-identity-outliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers
[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary
[**export-outliers-zip**](#export-outliers-zip) | **GET** `/outliers/export` | Iai identity outliers export
[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | Iai identity outliers summary
[**get-identity-outliers**](#get-identity-outliers) | **GET** `/outliers` | Iai get identity outliers
[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | Iai identity outliers latest summary
[**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary
[**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features
[**ignore-identity-outliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore
[**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
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).
@@ -71,7 +71,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()
# Below is a request that includes all optional parameters
@@ -87,7 +87,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-outlier-snapshots
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/beta/get-identity-outlier-snapshots)
@@ -138,7 +138,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()
# Below is a request that includes all optional parameters
@@ -155,7 +155,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-outliers
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/beta/get-identity-outliers)
@@ -207,7 +207,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()
# Below is a request that includes all optional parameters
@@ -224,7 +224,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-latest-identity-outlier-snapshots
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/beta/get-latest-identity-outlier-snapshots)
@@ -267,7 +267,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()
# Below is a request that includes all optional parameters
@@ -419,7 +419,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## ignore-identity-outliers
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/beta/ignore-identity-outliers)
@@ -460,7 +460,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(request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -549,7 +549,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## un-ignore-identity-outliers
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/beta/un-ignore-identity-outliers)
@@ -590,7 +590,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(request_body=new_request_body)
# Below is a request that includes all optional parameters

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

@@ -15,14 +15,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-peer-group-outliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List
[**get-peer-group-outliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list
## get-peer-group-outliers
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Identity Outliers List
Identity outliers list
-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers)
@@ -70,7 +70,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)
# Below is a request that includes all optional parameters

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

@@ -15,13 +15,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
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
## get-recommendations
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/beta/get-recommendations)
@@ -82,7 +82,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(recommendation_request_dto=new_recommendation_request_dto)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md
View File

@@ -19,7 +19,7 @@ Method | HTTP request | Description
[**create-role-mining-sessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session
[**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session
[**export-role-mining-potential-role**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session
[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3
[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to s3
[**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job
[**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries
[**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session
@@ -324,7 +324,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-role-mining-potential-role-async
Asynchronously export details for a potential role in a role mining session and upload to S3
Asynchronously export details for a potential role in a role mining session and upload to s3
This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-async)
@@ -373,7 +373,7 @@ with ApiClient(configuration) as api_client:
}''' # RoleMiningPotentialRoleExportRequest | (optional)
try:
# Asynchronously export details for a potential role in a role mining session and upload to S3
# Asynchronously export details for a potential role in a role mining session and upload to s3
results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters

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

@@ -31,15 +31,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity
[**get-identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details
[**get-identity**](#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/{identityId}/reset` | Reset an identity
[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
[**start-identities-invite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register
[**start-identity-processing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**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.
@@ -100,7 +100,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity
Identity Details
Identity details
This API returns a single identity using the Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity)
@@ -143,7 +143,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Identity Details
# Identity details
results = IdentitiesApi(api_client).get_identity(id=id)
# Below is a request that includes all optional parameters
@@ -345,7 +345,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identities
List Identities
List identities
This API returns a list of identities.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identities)
@@ -397,7 +397,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()
# Below is a request that includes all optional parameters
@@ -601,7 +601,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-identity-processing
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:
@@ -657,7 +657,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(process_identities_request=new_process_identities_request)
# Below is a request that includes all optional parameters

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

@@ -15,16 +15,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-identity-attribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute
[**delete-identity-attribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute
[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes
[**get-identity-attribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute
[**list-identity-attributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**put-identity-attribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
[**create-identity-attribute**](#create-identity-attribute) | **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
Create identity attribute
Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute)
@@ -88,7 +88,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(identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters
@@ -104,7 +104,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-attribute
Delete Identity Attribute
Delete identity attribute
This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute)
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
try:
# Delete Identity Attribute
# Delete identity attribute
IdentityAttributesApi(api_client).delete_identity_attribute(name=name)
# Below is a request that includes all optional parameters
@@ -160,7 +160,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-attributes-in-bulk
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. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk)
@@ -205,7 +205,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(identity_attribute_names=new_identity_attribute_names)
# Below is a request that includes all optional parameters
@@ -219,7 +219,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-attribute
Get Identity Attribute
Get identity attribute
This gets an identity attribute for a given technical name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute)
@@ -262,7 +262,7 @@ with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
try:
# Get Identity Attribute
# Get identity attribute
results = IdentityAttributesApi(api_client).get_identity_attribute(name=name)
# Below is a request that includes all optional parameters
@@ -278,7 +278,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-attributes
List Identity Attributes
List identity attributes
Use this API to get a collection of identity attributes.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes)
@@ -326,7 +326,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()
# Below is a request that includes all optional parameters
@@ -343,7 +343,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-identity-attribute
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. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute)
@@ -409,7 +409,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, identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters

18
docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md
View File

@@ -16,15 +16,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**compare-identity-snapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots
[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots
[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots
[**get-historical-identity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**get-historical-identity-events**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**get-identity-snapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**get-identity-start-date**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
[**list-historical-identities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities
[**list-identity-access-items**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity
[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot
[**list-identity-access-items**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List access items by identity
[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get identity access items snapshot
[**list-identity-snapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity
@@ -100,7 +100,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## compare-identity-snapshots-access-type
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/beta/compare-identity-snapshots-access-type)
@@ -156,7 +156,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)
# Below is a request that includes all optional parameters
@@ -558,7 +558,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-access-items
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
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-access-items)
@@ -615,7 +615,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)
# Below is a request that includes all optional parameters
@@ -632,7 +632,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-snapshot-access-items
Get Identity Access Items Snapshot
Get identity access items snapshot
Use this API to get a list of identity access items at a specified date, filtered by item type.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshot-access-items)
@@ -679,7 +679,7 @@ with ApiClient(configuration) as api_client:
type = 'account' # str | Access item type. (optional) # str | Access item type. (optional)
try:
# Get Identity Access Items Snapshot
# Get identity access items snapshot
results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date)
# Below is a request that includes all optional parameters

54
docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md
View File

@@ -26,21 +26,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile
[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile
[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles
[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles
[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**show-generate-identity-preview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile
[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles
[**show-generate-identity-preview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview
[**sync-identity-profile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile
## create-identity-profile
Create Identity Profile
Create identity profile
Create an identity profile.
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
@@ -131,7 +131,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
@@ -147,7 +147,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.
A token with ORG_ADMIN authority is required to call this API.
@@ -192,7 +192,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
@@ -208,7 +208,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.
@@ -256,7 +256,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
@@ -272,7 +272,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/beta/export-identity-profiles)
@@ -323,7 +323,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name,-priority' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional)
try:
# Export Identity Profiles
# Export identity profiles
results = IdentityProfilesApi(api_client).export_identity_profiles()
# Below is a request that includes all optional parameters
@@ -400,7 +400,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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -444,7 +444,7 @@ with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # 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
@@ -460,7 +460,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/beta/import-identity-profiles)
@@ -503,7 +503,7 @@ with ApiClient(configuration) as api_client:
identity_profile_exported_object = '''[sailpoint.beta.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
@@ -519,7 +519,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.
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
@@ -570,7 +570,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name,-priority' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
try:
# List Identity Profiles
# List identity profiles
results = IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
@@ -587,7 +587,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## show-generate-identity-preview
Generate Identity Profile Preview
Generate identity profile preview
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
@@ -658,7 +658,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).show_generate_identity_preview(identity_preview_request=new_identity_preview_request)
# Below is a request that includes all optional parameters
@@ -737,7 +737,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-identity-profile
Update Identity Profile
Update identity profile
Update the specified identity profile with this PATCH request.
A token with ORG_ADMIN authority is required to call this API to update the Identity Profile.
These fields cannot be updated:
@@ -791,7 +791,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

30
docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md
View File

@@ -19,11 +19,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
[**delete-launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete Launcher
[**get-launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get Launcher by ID
[**get-launchers**](#get-launchers) | **GET** `/launchers` | List all Launchers for tenant
[**put-launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher
[**start-launcher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher
[**delete-launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
[**get-launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
[**get-launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
[**put-launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
[**start-launcher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a launcher
## create-launcher
@@ -97,7 +97,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-launcher
Delete Launcher
Delete launcher
Delete the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher)
@@ -139,7 +139,7 @@ with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted
try:
# Delete Launcher
# Delete launcher
LaunchersApi(api_client).delete_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-launcher
Get Launcher by ID
Get launcher by id
Get details for the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher)
@@ -196,7 +196,7 @@ with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved
try:
# Get Launcher by ID
# Get launcher by id
results = LaunchersApi(api_client).get_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
@@ -212,7 +212,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-launchers
List all Launchers for tenant
List all launchers for tenant
Return a list of Launchers for the authenticated tenant
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers)
@@ -259,7 +259,7 @@ with ApiClient(configuration) as api_client:
limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10)
try:
# List all Launchers for tenant
# List all launchers for tenant
results = LaunchersApi(api_client).get_launchers()
# Below is a request that includes all optional parameters
@@ -275,7 +275,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-launcher
Replace Launcher
Replace launcher
Replace the given Launcher ID with given payload
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher)
@@ -331,7 +331,7 @@ with ApiClient(configuration) as api_client:
}''' # LauncherRequest | Payload to replace Launcher
try:
# Replace Launcher
# Replace launcher
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).put_launcher(launcher_id=launcher_id, launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
@@ -347,7 +347,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-launcher
Launch a Launcher
Launch a launcher
Launch the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher)
@@ -390,7 +390,7 @@ with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched
try:
# Launch a Launcher
# Launch a launcher
results = LaunchersApi(api_client).start_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md
View File

@@ -51,12 +51,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State
[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state
[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state
## get-lifecycle-states
Get Lifecycle State
Get lifecycle state
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -103,7 +103,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_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
@@ -119,7 +119,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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -169,7 +169,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

48
docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md
View File

@@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration
[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method
[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method
[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method
[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration
[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration
[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete mfa method configuration
[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method
[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method
[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method
[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration
[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration
[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration
[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method's test configuration
## delete-mfa-config
Delete MFA method configuration
Delete mfa method configuration
This API removes the configuration for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config)
@@ -68,7 +68,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:
# Delete MFA method configuration
# Delete mfa method configuration
results = MFAConfigurationApi(api_client).delete_mfa_config(method=method)
# Below is a request that includes all optional parameters
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## 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/beta/get-mfa-duo-config)
@@ -122,7 +122,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
@@ -138,7 +138,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/beta/get-mfa-kba-config)
@@ -180,7 +180,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
@@ -197,7 +197,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/beta/get-mfa-okta-config)
@@ -235,7 +235,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
@@ -251,7 +251,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/beta/set-mfa-duo-config)
@@ -303,7 +303,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
@@ -319,7 +319,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/beta/set-mfa-okta-config)
@@ -367,7 +367,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
@@ -383,7 +383,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/beta/set-mfakba-config)
@@ -426,7 +426,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
@@ -443,7 +443,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/beta/test-mfa-config)
@@ -485,7 +485,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

30
docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md
View File

@@ -16,11 +16,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-send-token**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token
[**ping-verification-status**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest
[**send-duo-verify-request**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method
[**send-kba-answers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method
[**send-okta-verify-request**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**send-token-auth-request**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
[**ping-verification-status**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling mfa method by verificationpollrequest
[**send-duo-verify-request**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via duo method
[**send-kba-answers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate kba provided mfa method
[**send-okta-verify-request**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via okta method
[**send-token-auth-request**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate token provided mfa method
## create-send-token
@@ -86,7 +86,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## ping-verification-status
Polling MFA method by VerificationPollRequest
Polling mfa method by verificationpollrequest
This API poll the VerificationPollRequest for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-verification-status)
@@ -133,7 +133,7 @@ with ApiClient(configuration) as api_client:
}''' # VerificationPollRequest |
try:
# Polling MFA method by VerificationPollRequest
# Polling mfa method by verificationpollrequest
new_verification_poll_request = VerificationPollRequest.from_json(verification_poll_request)
results = MFAControllerApi(api_client).ping_verification_status(method=method, verification_poll_request=new_verification_poll_request)
# Below is a request that includes all optional parameters
@@ -149,7 +149,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-duo-verify-request
Verifying authentication via Duo method
Verifying authentication via duo method
This API Authenticates the user via Duo-Web MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-duo-verify-request)
@@ -195,7 +195,7 @@ with ApiClient(configuration) as api_client:
}''' # DuoVerificationRequest |
try:
# Verifying authentication via Duo method
# Verifying authentication via duo method
new_duo_verification_request = DuoVerificationRequest.from_json(duo_verification_request)
results = MFAControllerApi(api_client).send_duo_verify_request(duo_verification_request=new_duo_verification_request)
# Below is a request that includes all optional parameters
@@ -211,7 +211,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-kba-answers
Authenticate KBA provided MFA method
Authenticate kba provided mfa method
This API Authenticate user in KBA MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-kba-answers)
@@ -254,7 +254,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:
# Authenticate KBA provided MFA method
# Authenticate kba provided mfa method
new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item)
results = MFAControllerApi(api_client).send_kba_answers(kba_answer_request_item=new_kba_answer_request_item)
# Below is a request that includes all optional parameters
@@ -270,7 +270,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-okta-verify-request
Verifying authentication via Okta method
Verifying authentication via okta method
This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-okta-verify-request)
@@ -315,7 +315,7 @@ with ApiClient(configuration) as api_client:
}''' # OktaVerificationRequest |
try:
# Verifying authentication via Okta method
# Verifying authentication via okta method
new_okta_verification_request = OktaVerificationRequest.from_json(okta_verification_request)
results = MFAControllerApi(api_client).send_okta_verify_request(okta_verification_request=new_okta_verification_request)
# Below is a request that includes all optional parameters
@@ -331,7 +331,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-token-auth-request
Authenticate Token provided MFA method
Authenticate token provided mfa method
This API Authenticate user in Token MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-token-auth-request)
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
}''' # TokenAuthRequest |
try:
# Authenticate Token provided MFA method
# Authenticate token provided mfa method
new_token_auth_request = TokenAuthRequest.from_json(token_auth_request)
results = MFAControllerApi(api_client).send_token_auth_request(token_auth_request=new_token_auth_request)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status.
[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified managed client status.
[**update-managed-client-status**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client
@@ -25,7 +25,7 @@ Method | HTTP request | Description
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Specified Managed Client Status.
Specified managed client status.
Retrieve Managed Client Status by ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-client-status)
@@ -71,7 +71,7 @@ with ApiClient(configuration) as api_client:
type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get
try:
# Specified Managed Client Status.
# Specified managed client status.
results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type)
# Below is a request that includes all optional parameters

12
docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md
View File

@@ -18,8 +18,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-client-log-configuration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration
[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified ManagedCluster.
[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters.
[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified managedcluster.
[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all managed clusters.
[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration
@@ -89,7 +89,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a specified ManagedCluster.
Get a specified managedcluster.
Retrieve a ManagedCluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster)
@@ -132,7 +132,7 @@ with ApiClient(configuration) as api_client:
id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get
try:
# Get a specified ManagedCluster.
# Get a specified managedcluster.
results = ManagedClustersApi(api_client).get_managed_cluster(id=id)
# Below is a request that includes all optional parameters
@@ -151,7 +151,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieve all Managed Clusters.
Retrieve all managed clusters.
Retrieve all Managed Clusters for the current Org, based on request context.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters)
@@ -199,7 +199,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* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional)
try:
# Retrieve all Managed Clusters.
# Retrieve all managed clusters.
results = ManagedClustersApi(api_client).get_managed_clusters()
# Below is a request that includes all optional parameters

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

@@ -18,23 +18,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-multi-host-integration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration
[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration
[**delete-multi-host**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration
[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID
[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID
[**get-multi-host-integrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID
[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations
[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors
[**get-multihost-integration-types**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types
[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration
[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration
[**test-source-connection-multihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source
[**update-multi-host-sources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration
[**create-multi-host-integration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration
[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration
[**delete-multi-host**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete multi-host integration
[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get account aggregation groups within multi-host integration id
[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get entitlement aggregation groups within multi-host integration id
[**get-multi-host-integrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get multi-host integration by id
[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List all existing multi-host integrations
[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors
[**get-multihost-integration-types**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List multi-host integration types
[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List sources within multi-host integration
[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration
[**test-source-connection-multihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source
[**update-multi-host-sources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration
## create-multi-host-integration
Create Multi-Host Integration
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.beta.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
Get Account Aggregation Groups Within Multi-Host Integration ID
Get account aggregation groups within multi-host integration id
This API will return array of account aggregation groups within provided Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
try:
# Get Account Aggregation Groups Within Multi-Host Integration ID
# Get account aggregation groups within multi-host integration id
results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
@@ -301,7 +301,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-entitlement-aggregation-groups
Get Entitlement Aggregation Groups Within Multi-Host Integration ID
Get entitlement aggregation groups within multi-host integration id
This API will return array of aggregation groups within provided Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -346,7 +346,7 @@ with ApiClient(configuration) as api_client:
multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
try:
# Get Entitlement Aggregation Groups Within Multi-Host Integration ID
# Get entitlement aggregation groups within multi-host 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
@@ -362,7 +362,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.
@@ -407,7 +407,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
@@ -423,7 +423,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.
@@ -478,7 +478,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
@@ -495,7 +495,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.
@@ -540,7 +540,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
@@ -557,7 +557,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.
@@ -598,7 +598,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
@@ -615,7 +615,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.
@@ -670,7 +670,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
@@ -687,7 +687,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.
@@ -731,7 +731,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
@@ -745,7 +745,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.
@@ -792,7 +792,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
@@ -808,7 +808,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.
@@ -855,7 +855,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

174
docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -46,42 +46,42 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request
[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record
[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request
[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source
[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute
[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record
[**delete-non-employee-record-in-bulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records
[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request
[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute
[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source
[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request
[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record
[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request
[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source
[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create non-employee source schema attribute
[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record
[**delete-non-employee-record-in-bulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records
[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request
[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete non-employee source's schema attribute
[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source
[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes
[**export-non-employee-records**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV
[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template
[**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` | Bulk upload status on source
[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record
[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request
[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests
[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source
[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source
[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source
[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records
[**list-non-employee-approval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests
[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records
[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests
[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources
[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record
[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute
[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source
[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record
[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record
[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request
[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests
[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source
[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source
[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source
[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records
[**list-non-employee-approval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests
[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records
[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests
[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources
[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record
[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch non-employee source's schema attribute
[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source
[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request
[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record
## approve-non-employee-request
Approve a Non-Employee Request
Approve a non-employee request
Approves a non-employee approval request and notifies the next approver.
[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-non-employee-request)
@@ -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.
Request will require the following security scope:
'idn:nesr:create'
@@ -202,7 +202,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
@@ -218,7 +218,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
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-request)
@@ -274,7 +274,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
@@ -290,7 +290,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/beta/create-non-employee-source)
@@ -358,7 +358,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
@@ -374,7 +374,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-source-schema-attributes
Create Non-Employee Source Schema Attribute
Create non-employee source schema attribute
This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source-schema-attributes)
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeSchemaAttributeBody |
try:
# Create Non-Employee Source Schema Attribute
# Create non-employee source schema attribute
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record)
@@ -483,7 +483,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID)
try:
# Delete Non-Employee Record
# Delete non-employee record
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id)
# Below is a request that includes all optional parameters
@@ -497,7 +497,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-record-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.
Request will require the following scope:
'idn:nesr:delete'
@@ -541,7 +541,7 @@ with ApiClient(configuration) as api_client:
delete_non_employee_record_in_bulk_request = '''sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest()''' # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body.
try:
# Delete Multiple Non-Employee Records
# Delete multiple non-employee records
new_delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest.from_json(delete_non_employee_record_in_bulk_request)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(delete_non_employee_record_in_bulk_request=new_delete_non_employee_record_in_bulk_request)
# Below is a request that includes all optional parameters
@@ -555,7 +555,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-request)
@@ -597,7 +597,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format
try:
# Delete Non-Employee Request
# 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 Non-Employee Source's Schema Attribute
Delete non-employee source's schema attribute
This end-point deletes a specific schema attribute for a non-employee source.
@@ -655,7 +655,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id
try:
# Delete Non-Employee Source's Schema Attribute
# Delete non-employee source's schema attribute
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
@@ -669,7 +669,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source)
@@ -710,7 +710,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c91808b6ef1d43e016efba0ce470904' # 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
@@ -779,7 +779,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-records)
@@ -821,7 +821,7 @@ with ApiClient(configuration) as api_client:
id = '2c918085842e69ae018432d22ccb212f' # 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
@@ -835,7 +835,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.
Request will require the following security scope:
idn:nesr:read'
@@ -879,7 +879,7 @@ with ApiClient(configuration) as api_client:
id = '2c918085842e69ae018432d22ccb212f' # 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
@@ -953,7 +953,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 current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval-summary)
@@ -995,7 +995,7 @@ with ApiClient(configuration) as api_client:
requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.
try:
# Get Summary of Non-Employee Approval Requests
# 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
@@ -1070,7 +1070,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-record)
@@ -1112,7 +1112,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID)
try:
# Get a Non-Employee Record
# Get a non-employee record
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id)
# Below is a request that includes all optional parameters
@@ -1128,7 +1128,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request)
@@ -1171,7 +1171,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID)
try:
# Get a Non-Employee Request
# Get a non-employee request
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id)
# Below is a request that includes all optional parameters
@@ -1187,7 +1187,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 current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request-summary)
@@ -1229,7 +1229,7 @@ with ApiClient(configuration) as api_client:
requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.
try:
# Get Summary of Non-Employee Requests
# 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
@@ -1245,7 +1245,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-schema-attribute)
@@ -1289,7 +1289,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c918085842e69ae018432d22ccb212f' # 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
@@ -1305,7 +1305,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source)
@@ -1347,7 +1347,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
@@ -1363,7 +1363,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source-schema-attributes)
@@ -1406,7 +1406,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c918085842e69ae018432d22ccb212f' # 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
@@ -1423,7 +1423,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.
Request will need the following security scope:
'idn:nesr:create'
@@ -1470,7 +1470,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
@@ -1486,7 +1486,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-approval
Get List of Non-Employee Approval Requests
Get list of non-employee approval requests
This gets a list of non-employee approval requests.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-approval)
@@ -1538,7 +1538,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_approval()
# Below is a request that includes all optional parameters
@@ -1555,7 +1555,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-records)
@@ -1605,7 +1605,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
@@ -1622,7 +1622,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-requests)
@@ -1674,7 +1674,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
@@ -1691,7 +1691,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.
@@ -1745,7 +1745,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
@@ -1762,7 +1762,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-record)
@@ -1808,7 +1808,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
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
@@ -1824,7 +1824,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-schema-attribute
Patch Non-Employee Source's Schema Attribute
Patch non-employee source's schema attribute
This end-point patches a specific schema attribute for a non-employee SourceId.
@@ -1873,7 +1873,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 Non-Employee Source's Schema Attribute
# Patch non-employee source's schema attribute
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
@@ -1889,7 +1889,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) Patchable field: **name, description, approvers, accountManagers**
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-source)
@@ -1934,7 +1934,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
@@ -1950,7 +1950,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-non-employee-request)
@@ -1997,7 +1997,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
@@ -2013,7 +2013,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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-non-employee-record)
@@ -2072,7 +2072,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/Beta/Methods/NotificationsApi.md
View File

@@ -15,25 +15,25 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-domain-dkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM
[**create-notification-template**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template
[**create-verified-from-address**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address
[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates
[**delete-verified-from-address**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address
[**get-dkim-attributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes
[**get-mail-from-attributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identityId}` | Get MAIL FROM Attributes
[**get-notification-template**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id
[**get-notifications-template-context**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context
[**list-from-addresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses
[**list-notification-preferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant.
[**list-notification-template-defaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults
[**list-notification-templates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates
[**put-mail-from-attributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**send-test-notification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
[**create-domain-dkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via dkim
[**create-notification-template**](#create-notification-template) | **POST** `/notification-templates` | Create notification template
[**create-verified-from-address**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create verified from address
[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk delete notification templates
[**delete-verified-from-address**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete verified from address
[**get-dkim-attributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get dkim attributes
[**get-mail-from-attributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identityId}` | Get mail from attributes
[**get-notification-template**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get notification template by id
[**get-notifications-template-context**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get notification template context
[**list-from-addresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List from addresses
[**list-notification-preferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List notification preferences for tenant.
[**list-notification-template-defaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List notification template defaults
[**list-notification-templates**](#list-notification-templates) | **GET** `/notification-templates` | List notification templates
[**put-mail-from-attributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change mail from domain
[**send-test-notification**](#send-test-notification) | **POST** `/send-test-notification` | Send test notification
## create-domain-dkim
Verify domain address via DKIM
Verify domain address via dkim
Create a domain to be verified via DKIM (DomainKeys Identified Mail)
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim)
@@ -79,7 +79,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(domain_address=new_domain_address)
# Below is a request that includes all optional parameters
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-notification-template
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.
@@ -156,7 +156,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(template_dto=new_template_dto)
# Below is a request that includes all optional parameters
@@ -172,7 +172,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-verified-from-address
Create Verified From Address
Create verified from address
Create a new sender email address and initiate verification process.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address)
@@ -219,7 +219,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(email_status_dto=new_email_status_dto)
# Below is a request that includes all optional parameters
@@ -235,7 +235,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-notification-templates-in-bulk
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/beta/delete-notification-templates-in-bulk)
@@ -277,7 +277,7 @@ with ApiClient(configuration) as api_client:
template_bulk_delete_dto = '''[sailpoint.beta.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(template_bulk_delete_dto=new_template_bulk_delete_dto)
# Below is a request that includes all optional parameters
@@ -291,7 +291,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-verified-from-address
Delete Verified From Address
Delete verified from address
Delete a verified sender email address
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address)
@@ -333,7 +333,7 @@ with ApiClient(configuration) as api_client:
id = 'id_example' # str | # str |
try:
# Delete Verified From Address
# Delete verified from address
NotificationsApi(api_client).delete_verified_from_address(id=id)
# Below is a request that includes all optional parameters
@@ -347,7 +347,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-dkim-attributes
Get DKIM Attributes
Get dkim attributes
Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-dkim-attributes)
@@ -385,7 +385,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get DKIM Attributes
# Get dkim attributes
results = NotificationsApi(api_client).get_dkim_attributes()
# Below is a request that includes all optional parameters
@@ -402,7 +402,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-mail-from-attributes
Get MAIL FROM Attributes
Get mail from attributes
Retrieve MAIL FROM attributes for a given AWS SES identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes)
@@ -444,7 +444,7 @@ with ApiClient(configuration) as api_client:
identity_id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
try:
# Get MAIL FROM Attributes
# Get mail from attributes
results = NotificationsApi(api_client).get_mail_from_attributes(identity_id=identity_id)
# Below is a request that includes all optional parameters
@@ -460,7 +460,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-notification-template
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/beta/get-notification-template)
@@ -502,7 +502,7 @@ with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template
try:
# Get Notification Template By Id
# Get notification template by id
results = NotificationsApi(api_client).get_notification_template(id=id)
# Below is a request that includes all optional parameters
@@ -519,7 +519,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-notifications-template-context
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).
@@ -558,7 +558,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Notification Template Context
# Get notification template context
results = NotificationsApi(api_client).get_notifications_template_context()
# Below is a request that includes all optional parameters
@@ -574,7 +574,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-from-addresses
List From Addresses
List from addresses
Retrieve a list of sender email addresses and their verification statuses
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses)
@@ -623,7 +623,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()
# Below is a request that includes all optional parameters
@@ -640,7 +640,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-notification-preferences
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/beta/list-notification-preferences)
@@ -683,7 +683,7 @@ with ApiClient(configuration) as api_client:
key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key.
try:
# List Notification Preferences for tenant.
# List notification preferences for tenant.
results = NotificationsApi(api_client).list_notification_preferences(key=key)
# Below is a request that includes all optional parameters
@@ -700,7 +700,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-notification-template-defaults
List Notification Template Defaults
List notification template defaults
This lists the default templates used for notifications, such as emails from IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-template-defaults)
@@ -746,7 +746,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()
# Below is a request that includes all optional parameters
@@ -763,7 +763,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-notification-templates
List Notification Templates
List notification templates
This lists the templates that you have modified for your site.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates)
@@ -809,7 +809,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()
# Below is a request that includes all optional parameters
@@ -826,7 +826,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-mail-from-attributes
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/beta/put-mail-from-attributes)
@@ -872,7 +872,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(mail_from_attributes_dto=new_mail_from_attributes_dto)
# Below is a request that includes all optional parameters
@@ -888,7 +888,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-test-notification
Send Test Notification
Send test notification
Send a Test Notification
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification)
@@ -935,7 +935,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(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/Beta/Methods/OAuthClientsApi.md
View File

@@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-oauth-client**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client
[**delete-oauth-client**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client
[**get-oauth-client**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client
[**list-oauth-clients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**patch-oauth-client**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
[**create-oauth-client**](#create-oauth-client) | **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/beta/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/beta/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/beta/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/beta/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.
Request will require a security scope of
- sp:oauth-client:manage
@@ -323,7 +323,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

12
docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md
View File

@@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-org-config**](#get-org-config) | **GET** `/org-config` | Get Org configuration settings
[**get-org-config**](#get-org-config) | **GET** `/org-config` | Get org configuration settings
[**get-valid-time-zones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones
[**patch-org-config**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property
[**patch-org-config**](#patch-org-config) | **PATCH** `/org-config` | Patch an org configuration property
## get-org-config
Get Org configuration settings
Get org configuration settings
Get org configuration with only external (org admin) accessible properties for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-org-config)
@@ -62,7 +62,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Org configuration settings
# Get org configuration settings
results = OrgConfigApi(api_client).get_org_config()
# Below is a request that includes all optional parameters
@@ -132,7 +132,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-org-config
Patch an Org configuration property
Patch an org configuration property
Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-org-config)
@@ -176,7 +176,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 an Org configuration property
# Patch an org configuration property
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OrgConfigApi(api_client).patch_org_config(json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-password-org-config**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config
[**get-password-org-config**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**put-password-org-config**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
[**create-password-org-config**](#create-password-org-config) | **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/beta/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/Beta/Methods/PasswordDictionaryApi.md
View File

@@ -62,12 +62,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-password-dictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**put-password-dictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
[**get-password-dictionary**](#get-password-dictionary) | **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/Beta/Methods/PasswordManagementApi.md
View File

@@ -40,9 +40,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-digit-token**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token
[**get-identity-password-change-status**](#get-identity-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status
[**query-password-info**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**set-identity-password**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password
[**get-identity-password-change-status**](#get-identity-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status
[**query-password-info**](#query-password-info) | **POST** `/query-password-info` | Query password info
[**set-identity-password**](#set-identity-password) | **POST** `/set-password` | Set identity's password
## create-digit-token
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-password-change-status
Get Password Change Request Status
Get password change request status
This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status)
@@ -151,7 +151,7 @@ with ApiClient(configuration) as api_client:
id = 'id_example' # str | # str |
try:
# Get Password Change Request Status
# Get password change request status
results = PasswordManagementApi(api_client).get_identity_password_change_status(id=id)
# Below is a request that includes all optional parameters
@@ -167,7 +167,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.
A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)
@@ -221,7 +221,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
@@ -237,7 +237,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-identity-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).
@@ -329,7 +329,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_identity_password(password_change_request=new_password_change_request)
# Below is a request that includes all optional parameters

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

@@ -24,15 +24,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-password-policy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy
[**delete-password-policy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID
[**get-password-policy-by-id**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID
[**list-password-policies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**set-password-policy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
[**create-password-policy**](#create-password-policy) | **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/beta/create-password-policy)
@@ -107,7 +107,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
@@ -123,7 +123,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/beta/delete-password-policy)
@@ -165,7 +165,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
@@ -179,7 +179,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/beta/get-password-policy-by-id)
@@ -222,7 +222,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
@@ -238,7 +238,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
@@ -285,7 +285,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
@@ -302,7 +302,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/beta/set-password-policy)
@@ -379,7 +379,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/Beta/Methods/PasswordSyncGroupsApi.md
View File

@@ -47,15 +47,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-password-sync-group**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group
[**delete-password-sync-group**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID
[**get-password-sync-group**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID
[**get-password-sync-groups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**update-password-sync-group**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
[**create-password-sync-group**](#create-password-sync-group) | **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/beta/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/beta/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/beta/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/beta/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/beta/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/Beta/Methods/PersonalAccessTokensApi.md
View File

@@ -26,14 +26,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-personal-access-token**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token
[**delete-personal-access-token**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token
[**list-personal-access-tokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**patch-personal-access-token**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
[**create-personal-access-token**](#create-personal-access-token) | **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/beta/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/beta/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/beta/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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-personal-access-token)
@@ -259,7 +259,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/Beta/Methods/PublicIdentitiesConfigApi.md
View File

@@ -25,15 +25,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config
[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config
[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get public identity config
[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update public identity config
## get-public-identity-config
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get Public Identity Config
Get public identity config
This gets details of public identity config.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-public-identity-config)
@@ -71,7 +71,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Public Identity Config
# Get public identity config
results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
# Below is a request that includes all optional parameters
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Public Identity Config
Update public identity config
This updates the details of public identity config.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config)
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
}''' # PublicIdentityConfig |
try:
# Update Public Identity Config
# Update public identity config
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

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

@@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**list-requestable-objects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
[**list-requestable-objects**](#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/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter.
Any authenticated token can call this endpoint to see their requestable access items.
@@ -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

48
docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md
View File

@@ -52,18 +52,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-role**](#create-role) | **POST** `/roles` | Create a Role
[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s)
[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a Role
[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements
[**list-roles**](#list-roles) | **GET** `/roles` | List Roles
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
[**create-role**](#create-role) | **POST** `/roles` | Create a role
[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s)
[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a role
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a role
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a role
[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's entitlements
[**list-roles**](#list-roles) | **GET** `/roles` | List roles
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified role
## create-role
Create a Role
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.
@@ -269,7 +269,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
@@ -285,7 +285,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.
@@ -333,7 +333,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
@@ -349,7 +349,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.
@@ -392,7 +392,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
@@ -406,7 +406,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.
@@ -449,7 +449,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
@@ -465,7 +465,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role-assigned-identities
Identities assigned a Role
Identities assigned a role
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assigned-identities)
@@ -517,7 +517,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:
# Identities assigned a Role
# Identities assigned a role
results = RolesApi(api_client).get_role_assigned_identities(id=id)
# Below is a request that includes all optional parameters
@@ -534,7 +534,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role-entitlements
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/beta/get-role-entitlements)
@@ -586,7 +586,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)
# Below is a request that includes all optional parameters
@@ -603,7 +603,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.
@@ -661,7 +661,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
@@ -678,7 +678,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:
@@ -743,7 +743,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

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

@@ -22,17 +22,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-sim-integration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration
[**delete-sim-integration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration
[**get-sim-integration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details.
[**get-sim-integrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations.
[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute.
[**patch-sim-attributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**put-sim-integration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
[**create-sim-integration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new sim integration
[**delete-sim-integration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a sim integration
[**get-sim-integration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a sim integration details.
[**get-sim-integrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing sim integrations.
[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute.
[**patch-sim-attributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a sim attribute.
[**put-sim-integration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing sim integration
## create-sim-integration
Create new SIM integration
Create new sim integration
Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sim-integration)
@@ -93,7 +93,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(sim_integration_details=new_sim_integration_details)
# Below is a request that includes all optional parameters
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-sim-integration
Delete a SIM integration
Delete a sim integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sim-integration)
@@ -151,7 +151,7 @@ with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete.
try:
# Delete a SIM integration
# Delete a sim integration
SIMIntegrationsApi(api_client).delete_sim_integration(id=id)
# Below is a request that includes all optional parameters
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sim-integration
Get a SIM integration details.
Get a sim integration details.
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integration)
@@ -208,7 +208,7 @@ with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
try:
# Get a SIM integration details.
# Get a sim integration details.
results = SIMIntegrationsApi(api_client).get_sim_integration(id=id)
# Below is a request that includes all optional parameters
@@ -224,7 +224,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sim-integrations
List the existing SIM integrations.
List the existing sim integrations.
List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integrations)
@@ -263,7 +263,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List the existing SIM integrations.
# List the existing sim integrations.
results = SIMIntegrationsApi(api_client).get_sim_integrations()
# Below is a request that includes all optional parameters
@@ -279,7 +279,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-before-provisioning-rule
Patch a SIM beforeProvisioningRule attribute.
Patch a sim beforeprovisioningrule attribute.
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-before-provisioning-rule)
@@ -325,7 +325,7 @@ with ApiClient(configuration) as api_client:
json_patch = '''"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
try:
# Patch a SIM beforeProvisioningRule attribute.
# Patch a sim beforeprovisioningrule attribute.
new_json_patch = JsonPatch.from_json(json_patch)
results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
@@ -341,7 +341,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-sim-attributes
Patch a SIM attribute.
Patch a sim attribute.
Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sim-attributes)
@@ -387,7 +387,7 @@ with ApiClient(configuration) as api_client:
json_patch = '''"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"''' # JsonPatch | The JsonPatch object that describes the changes of SIM
try:
# Patch a SIM attribute.
# Patch a sim attribute.
new_json_patch = JsonPatch.from_json(json_patch)
results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
@@ -403,7 +403,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-sim-integration
Update an existing SIM integration
Update an existing sim integration
Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sim-integration)
@@ -466,7 +466,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, sim_integration_details=new_sim_integration_details)
# Below is a request that includes all optional parameters

66
docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md
View File

@@ -41,29 +41,29 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-sod-policy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy
[**delete-sod-policy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID
[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule
[**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 a SOD policy
[**put-policy-schedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule
[**put-sod-policy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID
[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status
[**list-sod-policies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies
[**patch-sod-policy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch a sod policy
[**put-policy-schedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule
[**put-sod-policy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id
[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report
## create-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create SOD policy
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.
@@ -161,7 +161,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
@@ -180,7 +180,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete SOD policy by ID
Delete sod policy by id
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -225,7 +225,7 @@ with ApiClient(configuration) as api_client:
logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True)
try:
# Delete SOD policy by ID
# Delete sod policy by id
SODPoliciesApi(api_client).delete_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -242,7 +242,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete SOD policy schedule
Delete sod policy schedule
This deletes schedule for a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for.
try:
# Delete SOD policy schedule
# Delete sod policy schedule
SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -486,7 +486,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get SOD policy by ID
Get sod policy by id
This gets specified SOD policy.
Requires role of ORG_ADMIN.
@@ -530,7 +530,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 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
@@ -549,7 +549,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get SOD policy schedule
Get sod policy schedule
This endpoint gets a specified SOD policy's schedule.
Requires the role of ORG_ADMIN.
@@ -592,7 +592,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 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
@@ -674,7 +674,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
Requires role of ORG_ADMIN.
@@ -718,7 +718,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 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
@@ -737,7 +737,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List SOD policies
List sod policies
This gets list of all SOD policies.
Requires role of ORG_ADMIN
@@ -788,7 +788,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
@@ -808,7 +808,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Patch a SOD policy
Patch a sod policy
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Requires role of ORG_ADMIN.
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
@@ -855,7 +855,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[object] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
try:
# Patch a SOD policy
# Patch a sod policy
new_request_body = RequestBody.from_json(request_body)
results = SODPoliciesApi(api_client).patch_sod_policy(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -874,7 +874,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update SOD Policy schedule
Update sod policy schedule
This updates schedule for a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -1004,7 +1004,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
@@ -1023,7 +1023,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update SOD policy by ID
Update sod policy by id
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -1124,7 +1124,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
@@ -1208,7 +1208,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
Requires role of ORG_ADMIN.
@@ -1252,7 +1252,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Runs SOD policy violation report
# Runs sod policy violation report
results = SODPoliciesApi(api_client).start_sod_policy(id=id)
# Below is a request that includes all optional parameters

6
docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md
View File

@@ -33,14 +33,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity.
## start-predict-sod-violations
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Predict SOD violations for identity.
Predict sod violations for identity.
This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -97,7 +97,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

6
docs/tools/sdk/python/Reference/Beta/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
@@ -405,7 +405,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/beta/list-sp-config-objects)
@@ -444,7 +444,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

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

@@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes
[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute
[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes
[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes
[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute
[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes
[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute
[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute
## create-search-attribute-config
Create Extended Search Attributes
Create 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`.**
@@ -92,7 +92,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(search_attribute_config=new_search_attribute_config)
# Below is a request that includes all optional parameters
@@ -108,7 +108,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-search-attribute-config
Delete Extended Search Attribute
Delete extended search attribute
Delete an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-search-attribute-config)
@@ -149,7 +149,7 @@ with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete.
try:
# Delete Extended Search Attribute
# Delete extended search attribute
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name)
# Below is a request that includes all optional parameters
@@ -163,7 +163,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-search-attribute-config
List Extended Search Attributes
List extended search attributes
Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
A token with ORG_ADMIN authority is required to call this API.
@@ -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:
# List Extended Search Attributes
# List extended search attributes
results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
# Below is a request that includes all optional parameters
@@ -225,7 +225,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-single-search-attribute-config
Get Extended Search Attribute
Get extended search attribute
Get an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-single-search-attribute-config)
@@ -268,7 +268,7 @@ with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get.
try:
# Get Extended Search Attribute
# Get extended search attribute
results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name)
# Below is a request that includes all optional parameters
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-search-attribute-config
Update Extended Search Attribute
Update extended search attribute
Update an existing search attribute configuration.
You can patch these fields:
* name * displayName * applicationAttributes
@@ -333,7 +333,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, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-segment**](#create-segment) | **POST** `/segments` | Create Segment
[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID
[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID
[**list-segments**](#list-segments) | **GET** `/segments` | List Segments
[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
[**create-segment**](#create-segment) | **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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -107,7 +107,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
@@ -123,7 +123,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:** Segment deletion may take some time to go into effect.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -167,7 +167,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
@@ -181,7 +181,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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -225,7 +225,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
@@ -241,7 +241,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-segments
List Segments
List segments
This API returns a list of all segments.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -288,7 +288,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
@@ -305,7 +305,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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -352,7 +352,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/Beta/Methods/ServiceDeskIntegrationApi.md
View File

@@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration
[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration
[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration
[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing Service Desk integrations
[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName
[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types
[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration
[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration
[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration
[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing service desk integrations
[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname
[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types
[**get-status-check-details**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration
[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration
[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**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/beta/create-service-desk-integration)
@@ -125,7 +125,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
@@ -141,7 +141,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/beta/delete-service-desk-integration)
@@ -183,7 +183,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
@@ -197,7 +197,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/beta/get-service-desk-integration)
@@ -240,7 +240,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
@@ -256,7 +256,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration-list
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/beta/get-service-desk-integration-list)
@@ -307,7 +307,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_integration_list()
# Below is a request that includes all optional parameters
@@ -324,7 +324,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/beta/get-service-desk-integration-template)
@@ -367,7 +367,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
@@ -383,7 +383,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/beta/get-service-desk-integration-types)
@@ -422,7 +422,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
@@ -494,7 +494,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/beta/patch-service-desk-integration)
@@ -540,7 +540,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.beta.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
@@ -556,7 +556,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/beta/put-service-desk-integration)
@@ -631,7 +631,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

192
docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md
View File

@@ -72,53 +72,53 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow.
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source
[**delete**](#delete) | **DELETE** `/sources/{id}` | Delete Source by ID
[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{sourceId}/remove-accounts` | Remove All Accounts in a Source
[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType
[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID
[**get-correlation-config**](#get-correlation-config) | **GET** `/sources/{sourceId}/correlation-config` | Get Source Correlation Configuration
[**get-native-change-detection-config**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
[**delete**](#delete) | **DELETE** `/sources/{id}` | Delete source by id
[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{sourceId}/remove-accounts` | Remove all accounts in a source
[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id
[**get-correlation-config**](#get-correlation-config) | **GET** `/sources/{sourceId}/correlation-config` | Get source correlation configuration
[**get-native-change-detection-config**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get source by id
[**get-source-accounts-schema**](#get-source-accounts-schema) | **GET** `/sources/{sourceId}/schemas/accounts` | Downloads source accounts schema template
[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute sync config
[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{sourceId}/entitlement-request-config` | Get Source Entitlement Request Configuration
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{sourceId}/entitlement-request-config` | Get source entitlement request configuration
[**get-source-entitlements-schema**](#get-source-entitlements-schema) | **GET** `/sources/{sourceId}/schemas/entitlements` | Downloads source entitlements schema template
[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID
[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source
[**import-accounts**](#import-accounts) | **POST** `/sources/{sourceId}/load-accounts` | Account Aggregation
[**import-entitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement Aggregation
[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id
[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source
[**import-accounts**](#import-accounts) | **POST** `/sources/{sourceId}/load-accounts` | Account aggregation
[**import-entitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation
[**import-source-accounts-schema**](#import-source-accounts-schema) | **POST** `/sources/{sourceId}/schemas/accounts` | Uploads source accounts schema template
[**import-source-connector-file**](#import-source-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
[**import-source-entitlements-schema**](#import-source-entitlements-schema) | **POST** `/sources/{sourceId}/schemas/entitlements` | Uploads source entitlements schema template
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/load-uncorrelated-accounts` | Process Uncorrelated Accounts
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/load-uncorrelated-accounts` | Process uncorrelated accounts
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow.
[**peek-resource-objects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
[**ping-cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{sourceId}/correlation-config` | Update Source Correlation Configuration
[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration
[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{sourceId}/correlation-config` | Update source correlation configuration
[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration
[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update source (full)
[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update attribute sync config
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full)
[**sync-attributes-for-source**](#sync-attributes-for-source) | **POST** `/sources/{sourceId}/synchronize-attributes` | Synchronize single source attributes.
[**test-source-configuration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector
[**test-source-connection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector.
[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies
[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy
[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **PUT** `/sources/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration
[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies
[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy
[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial)
[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **PUT** `/sources/{sourceId}/entitlement-request-config` | Update source entitlement request configuration
[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial)
## create-provisioning-policy
Create Provisioning Policy
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.
@@ -204,7 +204,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
@@ -220,7 +220,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.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -347,7 +347,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
@@ -363,7 +363,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).
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-schema)
@@ -407,7 +407,7 @@ with ApiClient(configuration) as api_client:
model_schema = '''sailpoint.beta.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
@@ -423,7 +423,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete
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}`
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -468,7 +468,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(id=id)
# Below is a request that includes all optional parameters
@@ -484,7 +484,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-accounts-async
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:
@@ -532,7 +532,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id
try:
# Remove All Accounts in a Source
# Remove all accounts in a source
results = SourcesApi(api_client).delete_accounts_async(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -548,7 +548,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-native-change-detection-config
Delete Native Change Detection Configuration
Delete native change detection configuration
Deletes the native change detection configuration for the source specified by the given ID.
A token with API, or ORG_ADMIN authority is required to call this API.
@@ -591,7 +591,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id
try:
# Delete Native Change Detection Configuration
# Delete native change detection configuration
SourcesApi(api_client).delete_native_change_detection_config(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -605,7 +605,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/beta/delete-provisioning-policy)
@@ -650,7 +650,7 @@ with ApiClient(configuration) as api_client:
usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
try:
# Delete Provisioning Policy by UsageType
# 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
@@ -664,7 +664,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/beta/delete-source-schema)
@@ -708,7 +708,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
@@ -722,7 +722,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/beta/get-correlation-config)
@@ -765,7 +765,7 @@ with ApiClient(configuration) as api_client:
source_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(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -781,7 +781,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-native-change-detection-config
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.
A token with ORG_ADMIN authority is required to call this API.
@@ -825,7 +825,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id
try:
# Native Change Detection Configuration
# Native change detection configuration
results = SourcesApi(api_client).get_native_change_detection_config(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -841,7 +841,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/beta/get-provisioning-policy)
@@ -887,7 +887,7 @@ with ApiClient(configuration) as api_client:
usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
try:
# Get Provisioning Policy by UsageType
# 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
@@ -903,7 +903,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).
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -947,7 +947,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
@@ -1019,7 +1019,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-attr-sync-config
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.
A token with ORG_ADMIN or HELPDESK authority is required to call this API.
@@ -1063,7 +1063,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id
try:
# Attribute Sync Config
# Attribute sync config
results = SourcesApi(api_client).get_source_attr_sync_config(id=id)
# Below is a request that includes all optional parameters
@@ -1140,7 +1140,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-entitlement-request-config
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.
@@ -1188,7 +1188,7 @@ with ApiClient(configuration) as api_client:
source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id
try:
# Get Source Entitlement Request Configuration
# Get source entitlement request configuration
results = SourcesApi(api_client).get_source_entitlement_request_config(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1262,7 +1262,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.
@@ -1308,7 +1308,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
@@ -1324,7 +1324,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/beta/get-source-schemas)
@@ -1371,7 +1371,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
@@ -1388,7 +1388,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-accounts
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`.
@@ -1437,7 +1437,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(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1453,7 +1453,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-entitlements
Entitlement Aggregation
Entitlement aggregation
Starts an entitlement aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
You will also need to set the Content-Type header to `multipart/form-data`.
@@ -1500,7 +1500,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
try:
# Entitlement Aggregation
# Entitlement aggregation
results = SourcesApi(api_client).import_entitlements(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1699,7 +1699,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-uncorrelated-accounts
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/beta/import-uncorrelated-accounts)
@@ -1743,7 +1743,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(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1759,7 +1759,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/beta/list-provisioning-policies)
@@ -1802,7 +1802,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
@@ -1819,7 +1819,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.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.
@@ -1876,7 +1876,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
@@ -2019,7 +2019,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/beta/put-correlation-config)
@@ -2084,7 +2084,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(source_id=source_id, correlation_config=new_correlation_config)
# Below is a request that includes all optional parameters
@@ -2100,7 +2100,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-native-change-detection-config
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.
A token with ORG_ADMIN authority is required to call this API.
@@ -2154,7 +2154,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(source_id=source_id, native_change_detection_config=new_native_change_detection_config)
# Below is a request that includes all optional parameters
@@ -2170,7 +2170,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.
@@ -2259,7 +2259,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
@@ -2275,7 +2275,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:
@@ -2416,7 +2416,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
@@ -2432,7 +2432,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-source-attr-sync-config
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.
A token with ORG_ADMIN authority is required to call this API.
@@ -2496,7 +2496,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, attr_sync_source_config=new_attr_sync_source_config)
# Below is a request that includes all optional parameters
@@ -2512,7 +2512,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
* name
@@ -2564,7 +2564,7 @@ with ApiClient(configuration) as api_client:
model_schema = '''sailpoint.beta.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
@@ -2760,7 +2760,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/beta/update-provisioning-policies-in-bulk)
@@ -2805,7 +2805,7 @@ with ApiClient(configuration) as api_client:
provisioning_policy_dto = '''[sailpoint.beta.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
@@ -2822,7 +2822,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.
@@ -2873,7 +2873,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
@@ -2889,7 +2889,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.
@@ -2951,7 +2951,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
@@ -2967,7 +2967,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-source-entitlement-request-config
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.
@@ -3039,7 +3039,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(source_id=source_id, source_entitlement_request_config=new_source_entitlement_request_config)
# Below is a request that includes all optional parameters
@@ -3055,7 +3055,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:
@@ -3132,7 +3132,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/displayAttribute, value={new-display-attribute=null}}]''' # 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/Beta/Methods/SuggestedEntitlementDescriptionApi.md
View File

@@ -18,17 +18,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-sed-batch-stats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request
[**get-sed-batches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request
[**list-seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions
[**patch-sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description
[**submit-sed-approval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request
[**submit-sed-assignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**submit-sed-batch-request**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
[**get-sed-batch-stats**](#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)`.
@@ -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:
@@ -216,7 +216,7 @@ with ApiClient(configuration) as api_client:
show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional)
try:
# List Suggested Entitlement Descriptions
# List suggested entitlement descriptions
results = SuggestedEntitlementDescriptionApi(api_client).list_seds()
# Below is a request that includes all optional parameters
@@ -233,7 +233,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/beta/patch-sed)
@@ -279,7 +279,7 @@ with ApiClient(configuration) as api_client:
sed_patch = '''[sailpoint.beta.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
@@ -295,7 +295,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
@@ -340,7 +340,7 @@ with ApiClient(configuration) as api_client:
sed_approval = '''[sailpoint.beta.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
@@ -357,7 +357,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
@@ -408,7 +408,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
@@ -424,7 +424,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
@@ -475,7 +475,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/Beta/Methods/TaggedObjectsApi.md
View File

@@ -68,18 +68,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-tagged-object**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags
[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects
[**get-tagged-object**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object
[**list-tagged-objects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects
[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type
[**put-tagged-object**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object
[**set-tag-to-object**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
[**delete-tagged-object**](#delete-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/beta/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.
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -192,7 +192,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkTaggedObject | 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_tagged_object = BulkTaggedObject.from_json(bulk_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_tagged_object=new_bulk_tagged_object)
# Below is a request that includes all optional parameters
@@ -206,7 +206,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/beta/get-tagged-object)
@@ -250,7 +250,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
@@ -266,7 +266,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.
@@ -316,7 +316,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
@@ -333,7 +333,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.
@@ -385,7 +385,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
@@ -402,7 +402,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/beta/put-tagged-object)
@@ -455,7 +455,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
@@ -471,7 +471,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.
@@ -522,7 +522,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
@@ -536,7 +536,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.
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -592,7 +592,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Tag Multiple Objects
# Tag multiple objects
new_bulk_tagged_object = BulkTaggedObject.from_json(bulk_tagged_object)
results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_tagged_object=new_bulk_tagged_object)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md
View File

@@ -15,14 +15,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-tag**](#create-tag) | **POST** `/tags` | Create Tag
[**delete-tag-by-id**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete Tag
[**get-tag-by-id**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id
[**list-tags**](#list-tags) | **GET** `/tags` | List Tags
[**create-tag**](#create-tag) | **POST** `/tags` | Create tag
[**delete-tag-by-id**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
[**get-tag-by-id**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
[**list-tags**](#list-tags) | **GET** `/tags` | List tags
## create-tag
Create Tag
Create tag
This API creates new tag.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -80,7 +80,7 @@ with ApiClient(configuration) as api_client:
}''' # Tag |
try:
# Create Tag
# Create tag
new_tag = Tag.from_json(tag)
results = TagsApi(api_client).create_tag(tag=new_tag)
# Below is a request that includes all optional parameters
@@ -96,7 +96,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-tag-by-id
Delete Tag
Delete tag
This API deletes a tag by specified id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -140,7 +140,7 @@ with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete.
try:
# Delete Tag
# Delete tag
TagsApi(api_client).delete_tag_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-tag-by-id
Get Tag By Id
Get tag by id
Returns a tag by its id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -199,7 +199,7 @@ with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get Tag By Id
# Get tag by id
results = TagsApi(api_client).get_tag_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -215,7 +215,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-tags
List Tags
List tags
This API returns a list of tags.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -267,7 +267,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: **id, name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional)
try:
# List Tags
# List tags
results = TagsApi(api_client).list_tags()
# Below is a request that includes all optional parameters

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

@@ -15,15 +15,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-pending-task-headers**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers
[**get-pending-tasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List
[**get-task-status**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID
[**get-task-status-list**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List
[**update-task-status**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID
[**get-pending-task-headers**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve pending task list headers
[**get-pending-tasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve pending task status list
[**get-task-status**](#get-task-status) | **GET** `/task-status/{id}` | Get task status by id
[**get-task-status-list**](#get-task-status-list) | **GET** `/task-status` | Retrieve task status list
[**update-task-status**](#update-task-status) | **PATCH** `/task-status/{id}` | Update task status by id
## get-pending-task-headers
Retrieve Pending Task List Headers
Retrieve pending task list headers
Responds with headers only for list of task statuses for pending tasks.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-task-headers)
@@ -69,7 +69,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()
# Below is a request that includes all optional parameters
@@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-pending-tasks
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/beta/get-pending-tasks)
@@ -130,7 +130,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()
# Below is a request that includes all optional parameters
@@ -147,7 +147,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-task-status
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/beta/get-task-status)
@@ -190,7 +190,7 @@ with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID.
try:
# Get Task Status by ID
# Get task status by id
results = TaskManagementApi(api_client).get_task_status(id=id)
# Below is a request that includes all optional parameters
@@ -206,7 +206,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-task-status-list
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/beta/get-pending-tasks) endpoint.
@@ -258,7 +258,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()
# Below is a request that includes all optional parameters
@@ -275,7 +275,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-task-status
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/beta/update-task-status)
@@ -321,7 +321,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.beta.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, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information.
[**get-tenant**](#get-tenant) | **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/beta/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/Beta/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
@@ -149,7 +149,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.
A token with transform read authority is required to call this API.
@@ -193,7 +193,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/Beta/Methods/TriggersApi.md
View File

@@ -56,20 +56,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**complete-trigger-invocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation
[**create-subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription
[**delete-subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription
[**list-subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions
[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses
[**list-triggers**](#list-triggers) | **GET** `/triggers` | List Triggers
[**patch-subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription
[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation
[**test-subscription-filter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
[**update-subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
[**complete-trigger-invocation**](#complete-trigger-invocation) | **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
Complete trigger invocation
Completes an invocation to a REQUEST_RESPONSE type trigger.
[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation)
@@ -119,7 +119,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, complete_invocation=new_complete_invocation)
# Below is a request that includes all optional parameters
@@ -133,7 +133,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-subscription
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
@@ -202,7 +202,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(subscription_post_request=new_subscription_post_request)
# Below is a request that includes all optional parameters
@@ -218,7 +218,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-subscription
Delete a Subscription
Delete a subscription
Deletes an existing subscription to a trigger.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription)
@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID
try:
# Delete a Subscription
# Delete a subscription
TriggersApi(api_client).delete_subscription(id=id)
# Below is a request that includes all optional parameters
@@ -274,7 +274,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-subscriptions
List Subscriptions
List subscriptions
Gets a list of all trigger subscriptions.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions)
@@ -324,7 +324,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()
# Below is a request that includes all optional parameters
@@ -341,7 +341,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-trigger-invocation-status
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.
@@ -393,7 +393,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()
# Below is a request that includes all optional parameters
@@ -410,7 +410,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-triggers
List Triggers
List triggers
Gets a list of triggers that are available in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers)
@@ -460,7 +460,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()
# Below is a request that includes all optional parameters
@@ -477,7 +477,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-subscription
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**
@@ -525,7 +525,7 @@ with ApiClient(configuration) as api_client:
subscription_patch_request_inner = '''[sailpoint.beta.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, subscription_patch_request_inner=new_subscription_patch_request_inner)
# Below is a request that includes all optional parameters
@@ -541,7 +541,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-test-trigger-invocation
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/beta/start-test-trigger-invocation)
@@ -594,7 +594,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(test_invocation=new_test_invocation)
# Below is a request that includes all optional parameters
@@ -611,7 +611,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-subscription-filter
Validate a Subscription Filter
Validate a subscription filter
Validates a JSONPath filter expression against a provided mock input.
Request requires a security scope of:
@@ -660,7 +660,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(validate_filter_input_dto=new_validate_filter_input_dto)
# Below is a request that includes all optional parameters
@@ -676,7 +676,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-subscription
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:
@@ -754,7 +754,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, subscription_put_request=new_subscription_put_request)
# Below is a request that includes all optional parameters

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

@@ -16,12 +16,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant ui metadata
[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant ui metadata
## get-tenant-ui-metadata
Get a tenant UI metadata
Get a tenant ui metadata
This API endpoint retrieves UI metadata configured for your tenant.
A token with ORG_ADMIN authority is required to call this API.
@@ -61,7 +61,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get a tenant UI metadata
# Get a tenant ui metadata
results = UIMetadataApi(api_client).get_tenant_ui_metadata()
# Below is a request that includes all optional parameters
@@ -77,7 +77,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-tenant-ui-metadata
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.
A token with ORG_ADMIN authority is required to call this API.
@@ -126,7 +126,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(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/Beta/Methods/VendorConnectorMappingsApi.md
View File

@@ -19,13 +19,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping
[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings
[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **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/Beta/Methods/WorkItemsApi.md
View File

@@ -29,26 +29,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**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
[**submit-forward-work-item**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count work items
[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item
[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary
[**list-work-items**](#list-work-items) | **GET** `/work-items` | List work items
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections
[**submit-forward-work-item**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a work item
## approve-approval-item
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/approve-approval-item)
@@ -93,7 +93,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
@@ -112,7 +112,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/approve-approval-items-in-bulk)
@@ -155,7 +155,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
@@ -174,7 +174,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/complete-work-item)
@@ -219,7 +219,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
@@ -238,7 +238,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Completed Work Items
Completed work items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-completed-work-items)
@@ -287,7 +287,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
@@ -307,7 +307,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Count Completed Work Items
Count completed work items
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-completed-work-items)
@@ -354,7 +354,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:
# Count Completed Work Items
# Count completed work items
results = WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters
@@ -374,7 +374,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Count Work Items
Count work items
This gets a count of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-work-items)
@@ -417,7 +417,7 @@ with ApiClient(configuration) as api_client:
owner_id = '2c91808571bcfcf80171c23e4b4221fc' # 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
@@ -436,7 +436,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/get-work-item)
@@ -480,7 +480,7 @@ with ApiClient(configuration) as api_client:
owner_id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
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
@@ -499,7 +499,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Work Items Summary
Work items summary
This gets a summary of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-items-summary)
@@ -542,7 +542,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:
# Work Items Summary
# Work items summary
results = WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
@@ -561,7 +561,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List Work Items
List work items
This gets a collection of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-work-items)
@@ -610,7 +610,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:
# List Work Items
# List work items
results = WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
@@ -630,7 +630,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/reject-approval-item)
@@ -675,7 +675,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
@@ -694,7 +694,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/reject-approval-items-in-bulk)
@@ -737,7 +737,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
@@ -756,7 +756,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/submit-account-selection)
@@ -801,7 +801,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
@@ -820,7 +820,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/submit-forward-work-item)
@@ -868,7 +868,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).submit_forward_work_item(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters

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

@@ -25,19 +25,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-reassignment-configuration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration
[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration
[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration
[**get-reassignment-config-types**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types
[**get-reassignment-configuration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration
[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings
[**list-reassignment-configurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations
[**put-reassignment-config**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration
[**put-tenant-configuration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings
[**create-reassignment-configuration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a reassignment configuration
[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration
[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration
[**get-reassignment-config-types**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List reassignment config types
[**get-reassignment-configuration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get reassignment configuration
[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings
[**list-reassignment-configurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List reassignment configurations
[**put-reassignment-config**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update reassignment configuration
[**put-tenant-configuration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings
## create-reassignment-configuration
Create a Reassignment Configuration
Create a reassignment configuration
Creates a new Reassignment Configuration for the specified identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-reassignment-configuration)
@@ -86,7 +86,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(configuration_item_request=new_configuration_item_request)
# Below is a request that includes all optional parameters
@@ -102,7 +102,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-reassignment-configuration
Delete Reassignment Configuration
Delete reassignment configuration
Deletes a single reassignment configuration for the specified identity
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-reassignment-configuration)
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum |
try:
# Delete Reassignment Configuration
# Delete reassignment configuration
WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type)
# Below is a request that includes all optional parameters
@@ -160,7 +160,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-evaluate-reassignment-configuration
Evaluate Reassignment Configuration
Evaluate reassignment configuration
Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-evaluate-reassignment-configuration)
@@ -207,7 +207,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)
# Below is a request that includes all optional parameters
@@ -224,7 +224,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-reassignment-config-types
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/beta/get-reassignment-config-types)
@@ -262,7 +262,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Reassignment Config Types
# List reassignment config types
results = WorkReassignmentApi(api_client).get_reassignment_config_types()
# Below is a request that includes all optional parameters
@@ -279,7 +279,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-reassignment-configuration
Get Reassignment Configuration
Get reassignment configuration
Gets the Reassignment Configuration for an identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-configuration)
@@ -322,7 +322,7 @@ with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id
try:
# Get Reassignment Configuration
# Get reassignment configuration
results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id)
# Below is a request that includes all optional parameters
@@ -338,7 +338,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-tenant-config-configuration
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/beta/get-tenant-config-configuration)
@@ -377,7 +377,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Tenant-wide Reassignment Configuration settings
# Get tenant-wide reassignment configuration settings
results = WorkReassignmentApi(api_client).get_tenant_config_configuration()
# Below is a request that includes all optional parameters
@@ -393,7 +393,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-reassignment-configurations
List Reassignment Configurations
List reassignment configurations
Gets all Reassignment configuration for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations)
@@ -438,7 +438,7 @@ with ApiClient(configuration) as api_client:
offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
try:
# List Reassignment Configurations
# List reassignment configurations
results = WorkReassignmentApi(api_client).list_reassignment_configurations()
# Below is a request that includes all optional parameters
@@ -455,7 +455,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-reassignment-config
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/beta/put-reassignment-config)
@@ -506,7 +506,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, configuration_item_request=new_configuration_item_request)
# Below is a request that includes all optional parameters
@@ -522,7 +522,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-tenant-configuration
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/beta/put-tenant-configuration)
@@ -569,7 +569,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(tenant_configuration_request=new_tenant_configuration_request)
# Below is a request that includes all optional parameters

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

@@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID
[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow
[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id
[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id
[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution
[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History
[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions
[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library
[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions
[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators
[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers
[**list-workflows**](#list-workflows) | **GET** `/workflows` | List Workflows
[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow
[**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger
[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client
[**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-workflow**](#create-workflow) | **POST** `/workflows` | Create workflow
[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id
[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id
[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution
[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history
[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions
[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library
[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions
[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators
[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers
[**list-workflows**](#list-workflows) | **GET** `/workflows` | List workflows
[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow
[**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger
[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client
[**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/beta/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-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/beta/create-workflow)
@@ -136,7 +136,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
@@ -152,7 +152,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/beta/delete-workflow)
@@ -193,7 +193,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
@@ -207,7 +207,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/beta/get-workflow)
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True)
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
@@ -267,7 +267,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workflow-execution
Get Workflow Execution
Get workflow execution
Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution)
@@ -309,7 +309,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
@@ -325,7 +325,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/beta/get-workflow-execution-history)
@@ -368,7 +368,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
@@ -385,7 +385,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.
@@ -446,7 +446,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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
try:
# List Workflow Executions
# List workflow executions
results = WorkflowsApi(api_client).get_workflow_executions(id=id)
# Below is a request that includes all optional parameters
@@ -463,7 +463,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/beta/list-complete-workflow-library)
@@ -507,7 +507,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
@@ -524,7 +524,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/beta/list-workflow-library-actions)
@@ -570,7 +570,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
@@ -587,7 +587,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/beta/list-workflow-library-operators)
@@ -625,7 +625,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
@@ -642,7 +642,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/beta/list-workflow-library-triggers)
@@ -688,7 +688,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
@@ -705,7 +705,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/beta/list-workflows)
@@ -753,7 +753,7 @@ with ApiClient(configuration) as api_client:
connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional)
try:
# List Workflows
# List workflows
results = WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
@@ -770,7 +770,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/beta/patch-workflow)
@@ -815,7 +815,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
@@ -831,7 +831,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## post-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/beta/post-external-execute-workflow)
@@ -876,7 +876,7 @@ with ApiClient(configuration) as api_client:
post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
# Execute workflow via external trigger
results = WorkflowsApi(api_client).post_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -892,7 +892,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## post-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/beta/post-workflow-external-trigger)
@@ -934,7 +934,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).post_workflow_external_trigger(id=id)
# Below is a request that includes all optional parameters
@@ -950,7 +950,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/beta/put-workflow)
@@ -1034,7 +1034,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
@@ -1050,7 +1050,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/beta/test-external-execute-workflow)
@@ -1095,7 +1095,7 @@ with ApiClient(configuration) as api_client:
test_external_execute_workflow_request = '''sailpoint.beta.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
@@ -1111,7 +1111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-workflow
Test Workflow By Id
Test workflow by id
Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.
This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.
**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
@@ -1158,7 +1158,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