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

42
docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md
View File

@@ -49,17 +49,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile
[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile
[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s)
[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile
[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements
[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile
[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile
[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s)
[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile
[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements
[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles
[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile
## create-access-profile
Create Access Profile
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.
@@ -189,7 +189,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
@@ -205,7 +205,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.
@@ -250,7 +250,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
@@ -264,7 +264,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/v3/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 SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
@@ -443,7 +443,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
@@ -460,7 +460,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.
@@ -517,7 +517,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
@@ -534,7 +534,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**
@@ -608,7 +608,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

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

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

30
docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md
View File

@@ -30,15 +30,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit access request
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration
## cancel-access-request
Cancel Access Request
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.
@@ -85,7 +85,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
@@ -101,7 +101,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
@@ -359,7 +359,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
@@ -375,7 +375,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/v3/get-access-request-config)
@@ -413,7 +413,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
@@ -429,7 +429,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.
@@ -491,7 +491,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
@@ -508,7 +508,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/v3/set-access-request-config)
@@ -575,7 +575,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/V3/Methods/AccountActivitiesApi.md
View File

@@ -48,12 +48,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity
[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an account activity
[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List account activities
## get-account-activity
Get an Account Activity
Get an account activity
This gets a single account activity by its id.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-activity)
@@ -96,7 +96,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id
try:
# Get an Account Activity
# Get an account activity
results = AccountActivitiesApi(api_client).get_account_activity(id=id)
# Below is a request that includes all optional parameters
@@ -112,7 +112,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-account-activities
List Account Activities
List account activities
This gets a collection of account activities that satisfy the given query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-account-activities)
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional)
try:
# List Account Activities
# List account activities
results = AccountActivitiesApi(api_client).list_account_activities()
# Below is a request that includes all optional parameters

66
docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md
View File

@@ -42,21 +42,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-account**](#create-account) | **POST** `/accounts` | Create Account
[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account
[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account
[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account
[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account Details
[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements
[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts List
[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update Account
[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account
[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
[**create-account**](#create-account) | **POST** `/accounts` | Create account
[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account
[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account
[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account
[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account details
[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements
[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts list
[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update account
[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account
[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account
[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update account
## create-account
Create Account
Create account
Submit an account creation task - the API then returns the task ID.
You must include the `sourceId` where the account will be created in the `attributes` object.
@@ -119,7 +119,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
@@ -135,7 +135,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-account
Delete Account
Delete account
Use this API to delete an account.
This endpoint submits an account delete task and returns the task ID.
This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future.
@@ -181,7 +181,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
@@ -197,7 +197,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## disable-account
Disable Account
Disable account
This API submits a task to disable the account and returns the task ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/disable-account)
@@ -246,7 +246,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
@@ -262,7 +262,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## enable-account
Enable Account
Enable account
This API submits a task to enable account and returns the task ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/enable-account)
@@ -311,7 +311,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
@@ -327,7 +327,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-account
Account Details
Account details
Use this API to return the details for a single account by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account)
@@ -370,7 +370,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
@@ -386,7 +386,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-account-entitlements
Account Entitlements
Account entitlements
This API returns entitlements of the account.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-entitlements)
@@ -435,7 +435,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
@@ -452,7 +452,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-accounts
Accounts List
Accounts list
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-accounts)
@@ -504,7 +504,7 @@ with ApiClient(configuration) as api_client:
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
try:
# Accounts List
# Accounts list
results = AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
@@ -521,7 +521,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-account
Update Account
Update account
Use this API to update an account with a PUT request.
This endpoint submits an account update task and returns the task ID.
@@ -580,7 +580,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
@@ -596,7 +596,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-reload-account
Reload Account
Reload account
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reload-account)
@@ -639,7 +639,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
@@ -655,7 +655,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## unlock-account
Unlock Account
Unlock account
This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required.
@@ -706,7 +706,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
@@ -722,7 +722,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-account
Update Account
Update account
Use this API to update account details.
This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields.
@@ -776,7 +776,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=remove, path=/identityId}]''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Account
# Update account
new_request_body = RequestBody.from_json(request_body)
results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters

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

@@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-discovered-applications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant
[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
[**get-discovered-applications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get discovered applications for tenant
[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery
[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications
## get-discovered-applications
Get Discovered Applications for Tenant
Get discovered applications for tenant
Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
@@ -74,7 +74,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional)
try:
# Get Discovered Applications for Tenant
# Get discovered applications for tenant
results = ApplicationDiscoveryApi(api_client).get_discovered_applications()
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-manual-discover-applications-csv-template
Download CSV Template for Discovery
Download csv template for discovery
Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'.
The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
@@ -132,7 +132,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Download CSV Template for Discovery
# Download csv template for discovery
results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
# Below is a request that includes all optional parameters
@@ -148,7 +148,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Upload CSV to Discover Applications
Upload csv to discover applications
Uploading a CSV file with application data for manual correlation to specific ISC connectors.
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
@@ -190,7 +190,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
try:
# Upload CSV to Discover Applications
# Upload csv to discover applications
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file)
# Below is a request that includes all optional parameters

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

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

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

@@ -42,15 +42,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-campaign-filter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter
[**delete-campaign-filters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters
[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID
[**list-campaign-filters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters
[**update-campaign-filter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter
[**create-campaign-filter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create campaign filter
[**delete-campaign-filters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes campaign filters
[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get campaign filter by id
[**list-campaign-filters**](#list-campaign-filters) | **GET** `/campaign-filters` | List campaign filters
[**update-campaign-filter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a campaign filter
## create-campaign-filter
Create Campaign Filter
Create campaign filter
Use this API to create a campaign filter based on filter details and criteria.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-filter)
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignFilterDetails |
try:
# Create Campaign Filter
# Create campaign filter
new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details)
results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details)
# Below is a request that includes all optional parameters
@@ -125,7 +125,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaign-filters
Deletes Campaign Filters
Deletes campaign filters
Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-filters)
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] | A json list of IDs of campaign filters to delete.
try:
# Deletes Campaign Filters
# Deletes campaign filters
new_request_body = RequestBody.from_json(request_body)
CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -181,7 +181,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-filter-by-id
Get Campaign Filter by ID
Get campaign filter by id
Retrieves information for an existing campaign filter using the filter's ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-filter-by-id)
@@ -224,7 +224,7 @@ with ApiClient(configuration) as api_client:
id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter to be retrieved. # str | The ID of the campaign filter to be retrieved.
try:
# Get Campaign Filter by ID
# Get campaign filter by id
results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id)
# Below is a request that includes all optional parameters
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-campaign-filters
List Campaign Filters
List campaign filters
Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-campaign-filters)
@@ -286,7 +286,7 @@ with ApiClient(configuration) as api_client:
include_system_filters = True # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True)
try:
# List Campaign Filters
# List campaign filters
results = CertificationCampaignFiltersApi(api_client).list_campaign_filters()
# Below is a request that includes all optional parameters
@@ -302,7 +302,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-campaign-filter
Updates a Campaign Filter
Updates a campaign filter
Updates an existing campaign filter using the filter's ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign-filter)
@@ -363,7 +363,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignFilterDetails | A campaign filter details with updated field values.
try:
# Updates a Campaign Filter
# Updates a campaign filter
new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details)
results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details)
# Below is a request that includes all optional parameters

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

@@ -80,32 +80,32 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign
[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign
[**create-campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign
[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template
[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template
[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule
[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns
[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns
[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign
[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports
[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration
[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template
[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule
[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates
[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications
[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template
[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration
[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule
[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign
[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan
[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report
[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template
[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template
[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule
[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns
[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns
[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign
[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports
[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration
[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template
[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule
[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates
[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications
[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template
[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration
[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule
[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign
[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan
[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report
[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template
[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign
## complete-campaign
Complete a Campaign
Complete a campaign
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -162,7 +162,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
try:
# Complete a Campaign
# Complete a campaign
results = CertificationCampaignsApi(api_client).complete_campaign(id=id)
# Below is a request that includes all optional parameters
@@ -345,7 +345,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-campaign-template
Create a Campaign Template
Create a campaign template
Use this API to create a certification campaign template based on campaign.
@@ -511,7 +511,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
@@ -527,7 +527,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaign-template
Delete a Campaign Template
Delete a campaign template
Use this API to delete a certification campaign template by ID.
@@ -570,7 +570,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
@@ -584,7 +584,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaign-template-schedule
Delete Campaign Template Schedule
Delete campaign template schedule
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
@@ -627,7 +627,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
@@ -641,7 +641,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-campaigns
Delete Campaigns
Delete campaigns
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
@@ -687,7 +687,7 @@ with ApiClient(configuration) as api_client:
}''' # CampaignsDeleteRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
# Delete campaigns
new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request)
results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request)
# Below is a request that includes all optional parameters
@@ -703,7 +703,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-active-campaigns
List Campaigns
List campaigns
Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
@@ -756,7 +756,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
@@ -773,7 +773,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign
Get Campaign
Get campaign
Use this API to get information for an existing certification campaign by the campaign's ID.
@@ -819,7 +819,7 @@ with ApiClient(configuration) as api_client:
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
try:
# Get Campaign
# Get campaign
results = CertificationCampaignsApi(api_client).get_campaign(id=id)
# Below is a request that includes all optional parameters
@@ -835,7 +835,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-reports
Get Campaign Reports
Get campaign reports
Use this API to fetch all reports for a certification campaign by campaign ID.
@@ -879,7 +879,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
@@ -896,7 +896,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-reports-config
Get Campaign Reports Configuration
Get campaign reports configuration
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
@@ -935,7 +935,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
@@ -951,7 +951,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-template
Get a Campaign Template
Get a campaign template
Use this API to fetch a certification campaign template by ID.
@@ -995,7 +995,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
@@ -1011,7 +1011,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-template-schedule
Get Campaign Template Schedule
Get campaign template schedule
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
@@ -1055,7 +1055,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
@@ -1071,7 +1071,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-campaign-templates
List Campaign Templates
List campaign templates
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
The API returns all campaign templates matching the query parameters.
@@ -1124,7 +1124,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
@@ -1141,7 +1141,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## move
Reassign Certifications
Reassign certifications
This API reassigns the specified certifications from one identity to another.
@@ -1195,7 +1195,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
@@ -1211,7 +1211,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-campaign-template
Update a Campaign Template
Update a campaign template
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1258,7 +1258,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
@@ -1274,7 +1274,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-campaign-reports-config
Set Campaign Reports Configuration
Set campaign reports configuration
Use this API to overwrite the configuration for campaign reports.
@@ -1319,7 +1319,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
@@ -1335,7 +1335,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-campaign-template-schedule
Set Campaign Template Schedule
Set campaign template schedule
Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
@@ -1400,7 +1400,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
@@ -1414,7 +1414,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-campaign
Activate a Campaign
Activate a campaign
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
@@ -1462,7 +1462,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
@@ -1478,7 +1478,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-campaign-remediation-scan
Run Campaign Remediation Scan
Run campaign remediation scan
Use this API to run a remediation scan task for a certification campaign.
@@ -1521,7 +1521,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
@@ -1537,7 +1537,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-campaign-report
Run Campaign Report
Run campaign report
Use this API to run a report for a certification campaign.
@@ -1583,7 +1583,7 @@ with ApiClient(configuration) as api_client:
type = sailpoint.v3.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run.
try:
# Run Campaign Report
# Run campaign report
results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type)
# Below is a request that includes all optional parameters
@@ -1599,7 +1599,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-generate-campaign-template
Generate a Campaign from Template
Generate a campaign from template
Use this API to generate a new certification campaign from a campaign template.
The campaign object contained in the template has special formatting applied to its name and description
@@ -1652,7 +1652,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
@@ -1668,7 +1668,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-campaign
Update a Campaign
Update a campaign
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1715,7 +1715,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
try:
# Update a Campaign
# Update a campaign
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -29,14 +29,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-identity-access-summaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries
[**get-identity-decision-summary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions
[**get-identity-summaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification
[**get-identity-summary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity
[**get-identity-access-summaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access summaries
[**get-identity-decision-summary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of certification decisions
[**get-identity-summaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification
[**get-identity-summary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity
## get-identity-access-summaries
Access Summaries
Access summaries
This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-access-summaries)
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional)
try:
# Access Summaries
# Access summaries
results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type)
# Below is a request that includes all optional parameters
@@ -108,7 +108,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-decision-summary
Summary of Certification Decisions
Summary of certification decisions
This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-decision-summary)
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional)
try:
# Summary of Certification Decisions
# Summary of certification decisions
results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id)
# Below is a request that includes all optional parameters
@@ -169,7 +169,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-summaries
Identity Summaries for Campaign Certification
Identity summaries for campaign certification
This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summaries)
@@ -222,7 +222,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
try:
# Identity Summaries for Campaign Certification
# Identity summaries for campaign certification
results = CertificationSummariesApi(api_client).get_identity_summaries(id=id)
# Below is a request that includes all optional parameters
@@ -239,7 +239,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-summary
Summary for Identity
Summary for identity
This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summary)
@@ -284,7 +284,7 @@ with ApiClient(configuration) as api_client:
identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID
try:
# Summary for Identity
# Summary for identity
results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id)
# Below is a request that includes all optional parameters

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

@@ -38,21 +38,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-certification-task**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID
[**get-identity-certification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID
[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item
[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks
[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**list-identity-access-review-items**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items
[**list-identity-certifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications
[**make-identity-decision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item
[**reassign-identity-certifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items
[**sign-off-identity-certification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions
[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
[**get-certification-task**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification task by id
[**get-identity-certification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity certification by id
[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item
[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of pending certification tasks
[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification
[**list-identity-access-review-items**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of access review items
[**list-identity-certifications**](#list-identity-certifications) | **GET** `/certifications` | List identity campaign certifications
[**make-identity-decision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a certification item
[**reassign-identity-certifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign identities or items
[**sign-off-identity-certification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize identity certification decisions
[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously
## get-certification-task
Certification Task by ID
Certification task by id
This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-certification-task)
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID
try:
# Certification Task by ID
# Certification task by id
results = CertificationsApi(api_client).get_certification_task(id=id)
# Below is a request that includes all optional parameters
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-certification
Identity Certification by ID
Identity certification by id
This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification)
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id
try:
# Identity Certification by ID
# Identity certification by id
results = CertificationsApi(api_client).get_identity_certification(id=id)
# Below is a request that includes all optional parameters
@@ -170,7 +170,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-certification-item-permissions
Permissions for Entitlement Certification Item
Permissions for entitlement certification item
This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification-item-permissions)
@@ -223,7 +223,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# Permissions for Entitlement Certification Item
# Permissions for entitlement certification item
results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id)
# Below is a request that includes all optional parameters
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-pending-certification-tasks
List of Pending Certification Tasks
List of pending certification tasks
This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-pending-certification-tasks)
@@ -291,7 +291,7 @@ with ApiClient(configuration) as api_client:
filters = 'type eq \"ADMIN_REASSIGN\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional)
try:
# List of Pending Certification Tasks
# List of pending certification tasks
results = CertificationsApi(api_client).get_pending_certification_tasks()
# Below is a request that includes all optional parameters
@@ -308,7 +308,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-certification-reviewers
List of Reviewers for certification
List of reviewers for certification
This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-certification-reviewers)
@@ -361,7 +361,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional)
try:
# List of Reviewers for certification
# List of reviewers for certification
results = CertificationsApi(api_client).list_certification_reviewers(id=id)
# Below is a request that includes all optional parameters
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-access-review-items
List of Access Review Items
List of access review items
This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-access-review-items)
@@ -437,7 +437,7 @@ with ApiClient(configuration) as api_client:
roles = 'userRole' # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional)
try:
# List of Access Review Items
# List of access review items
results = CertificationsApi(api_client).list_identity_access_review_items(id=id)
# Below is a request that includes all optional parameters
@@ -454,7 +454,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-certifications
List Identity Campaign Certifications
List identity campaign certifications
Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-certifications)
@@ -506,7 +506,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name,due' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional)
try:
# List Identity Campaign Certifications
# List identity campaign certifications
results = CertificationsApi(api_client).list_identity_certifications()
# Below is a request that includes all optional parameters
@@ -523,7 +523,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## make-identity-decision
Decide on a Certification Item
Decide on a certification item
The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/make-identity-decision)
@@ -569,7 +569,7 @@ with ApiClient(configuration) as api_client:
review_decision = '''[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]''' # List[ReviewDecision] | A non-empty array of decisions to be made.
try:
# Decide on a Certification Item
# Decide on a certification item
new_review_decision = ReviewDecision.from_json(review_decision)
results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision)
# Below is a request that includes all optional parameters
@@ -585,7 +585,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reassign-identity-certifications
Reassign Identities or Items
Reassign identities or items
This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reassign-identity-certifications)
@@ -641,7 +641,7 @@ with ApiClient(configuration) as api_client:
}''' # ReviewReassign |
try:
# Reassign Identities or Items
# Reassign identities or items
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters
@@ -657,7 +657,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## sign-off-identity-certification
Finalize Identity Certification Decisions
Finalize identity certification decisions
This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/sign-off-identity-certification)
@@ -700,7 +700,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
try:
# Finalize Identity Certification Decisions
# Finalize identity certification decisions
results = CertificationsApi(api_client).sign_off_identity_certification(id=id)
# Below is a request that includes all optional parameters
@@ -716,7 +716,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-reassign-certs-async
Reassign Certifications Asynchronously
Reassign certifications asynchronously
This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another
reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the
reassignment is complete.
@@ -777,7 +777,7 @@ with ApiClient(configuration) as api_client:
}''' # ReviewReassign |
try:
# Reassign Certifications Asynchronously
# Reassign certifications asynchronously
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters

24
docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md
View File

@@ -26,12 +26,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create-object-mapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping
[**create-object-mappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings
[**create-uploaded-configuration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration
[**create-uploaded-configuration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a configuration
[**delete-object-mapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping
[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration
[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration
[**get-object-mappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings
[**get-uploaded-configuration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration
[**list-uploaded-configurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**get-uploaded-configuration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration
[**list-uploaded-configurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List uploaded configurations
[**update-object-mappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
@@ -186,7 +186,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-uploaded-configuration
Upload a Configuration
Upload a configuration
This API uploads a JSON configuration file into a tenant.
Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality.
@@ -234,7 +234,7 @@ with ApiClient(configuration) as api_client:
name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file.
try:
# Upload a Configuration
# Upload a configuration
results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name)
# Below is a request that includes all optional parameters
@@ -311,7 +311,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-uploaded-configuration
Delete an Uploaded Configuration
Delete an uploaded configuration
This API deletes an uploaded configuration based on Id.
On success, this endpoint will return an empty response.
@@ -357,7 +357,7 @@ with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Delete an Uploaded Configuration
# Delete an uploaded configuration
ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
@@ -434,7 +434,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-uploaded-configuration
Get an Uploaded Configuration
Get an uploaded configuration
This API gets an existing uploaded configuration for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-uploaded-configuration)
@@ -477,7 +477,7 @@ with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Get an Uploaded Configuration
# Get an uploaded configuration
results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
@@ -493,7 +493,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-uploaded-configurations
List Uploaded Configurations
List uploaded configurations
This API gets a list of existing uploaded configurations for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-uploaded-configurations)
@@ -536,7 +536,7 @@ with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
try:
# List Uploaded Configurations
# List uploaded configurations
results = ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters

66
docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md
View File

@@ -29,21 +29,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-custom-connector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector
[**delete-custom-connector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name
[**get-connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name
[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get Connector List
[**get-connector-source-config**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration
[**get-connector-source-template**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template
[**get-connector-translations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations
[**put-connector-source-config**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration
[**put-connector-source-template**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template
[**put-connector-translations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**update-connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
[**create-custom-connector**](#create-custom-connector) | **POST** `/connectors` | Create custom connector
[**delete-custom-connector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete connector by script name
[**get-connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get connector by script name
[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get connector list
[**get-connector-source-config**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get connector source configuration
[**get-connector-source-template**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get connector source template
[**get-connector-translations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get connector translations
[**put-connector-source-config**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update connector source configuration
[**put-connector-source-template**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update connector source template
[**put-connector-translations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update connector translations
[**update-connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update connector by script name
## create-custom-connector
Create Custom Connector
Create custom connector
Create custom connector.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-custom-connector)
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
}''' # V3CreateConnectorDto |
try:
# Create Custom Connector
# Create custom connector
new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto)
results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto)
# Below is a request that includes all optional parameters
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-custom-connector
Delete Connector by Script Name
Delete connector by script name
Delete a custom connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-custom-connector)
@@ -151,7 +151,7 @@ with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Delete Connector by Script Name
# Delete connector by script name
ConnectorsApi(api_client).delete_custom_connector(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector
Get Connector by Script Name
Get connector by script name
Fetches a connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector)
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
try:
# Get Connector by Script Name
# Get connector by script name
results = ConnectorsApi(api_client).get_connector(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-list
Get Connector List
Get connector list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-list)
@@ -277,7 +277,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
@@ -294,7 +294,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-source-config
Get Connector Source Configuration
Get connector source configuration
Fetches a connector's source config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-config)
@@ -336,7 +336,7 @@ with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Get Connector Source Configuration
# Get connector source configuration
results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -352,7 +352,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-source-template
Get Connector Source Template
Get connector source template
Fetches a connector's source template using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-template)
@@ -394,7 +394,7 @@ with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Get Connector Source Template
# Get connector source template
results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -410,7 +410,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-translations
Get Connector Translations
Get connector translations
Fetches a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-translations)
@@ -454,7 +454,7 @@ with ApiClient(configuration) as api_client:
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
try:
# Get Connector Translations
# Get connector translations
results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
@@ -470,7 +470,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-source-config
Update Connector Source Configuration
Update connector source configuration
Update a connector's source config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-config)
@@ -515,7 +515,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
try:
# Update Connector Source Configuration
# Update connector source configuration
results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -531,7 +531,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-source-template
Update Connector Source Template
Update connector source template
Update a connector's source template using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-template)
@@ -576,7 +576,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
try:
# Update Connector Source Template
# Update connector source template
results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -592,7 +592,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-translations
Update Connector Translations
Update connector translations
Update a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-translations)
@@ -637,7 +637,7 @@ with ApiClient(configuration) as api_client:
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
try:
# Update Connector Translations
# Update connector translations
results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
@@ -653,7 +653,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-connector
Update Connector by Script Name
Update connector by script name
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
@@ -711,7 +711,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations
try:
# Update Connector by Script Name
# Update connector by script name
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

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

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

@@ -25,21 +25,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**show-identity-preview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile
[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile
[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles
[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles
[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile
[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles
[**show-identity-preview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview
[**sync-identity-profile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile
## create-identity-profile
Create Identity Profile
Create identity profile
Creates an identity profile.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile)
@@ -129,7 +129,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityProfile |
try:
# Create Identity Profile
# Create identity profile
new_identity_profile = IdentityProfile.from_json(identity_profile)
results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile)
# Below is a request that includes all optional parameters
@@ -145,7 +145,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-profile
Delete Identity Profile
Delete identity profile
Delete an identity profile by ID.
On success, this endpoint will return a reference to the bulk delete task result.
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
try:
# Delete Identity Profile
# Delete identity profile
results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -205,7 +205,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-profiles
Delete Identity Profiles
Delete identity profiles
This deletes multiple Identity Profiles via a list of supplied IDs.
On success, this endpoint will return a reference to the bulk delete task result.
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] | Identity Profile bulk delete request body.
try:
# Delete Identity Profiles
# Delete identity profiles
new_request_body = RequestBody.from_json(request_body)
results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body)
# Below is a request that includes all optional parameters
@@ -267,7 +267,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-identity-profiles
Export Identity Profiles
Export identity profiles
This exports existing identity profiles in the format specified by the sp-config service.
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-identity-profiles)
@@ -317,7 +317,7 @@ with ApiClient(configuration) as api_client:
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional)
try:
# Export Identity Profiles
# Export identity profiles
results = IdentityProfilesApi(api_client).export_identity_profiles()
# Below is a request that includes all optional parameters
@@ -334,7 +334,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-default-identity-attribute-config
Get default Identity Attribute Config
Get default identity attribute config
This returns the default identity attribute config.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-identity-attribute-config)
@@ -377,7 +377,7 @@ with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Get default Identity Attribute Config
# Get default identity attribute config
results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -393,7 +393,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-profile
Get Identity Profile
Get identity profile
Get a single identity profile by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile)
@@ -436,7 +436,7 @@ with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
try:
# Get Identity Profile
# Get identity profile
results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -452,7 +452,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/v3/import-identity-profiles)
@@ -495,7 +495,7 @@ with ApiClient(configuration) as api_client:
identity_profile_exported_object = '''[sailpoint.v3.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
@@ -511,7 +511,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-profiles
List Identity Profiles
List identity profiles
Get a list of identity profiles, based on the specified query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles)
@@ -561,7 +561,7 @@ with ApiClient(configuration) as api_client:
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
try:
# List Identity Profiles
# List identity profiles
results = IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
@@ -578,7 +578,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## show-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.
@@ -648,7 +648,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_identity_preview(identity_preview_request=new_identity_preview_request)
# Below is a request that includes all optional parameters
@@ -726,7 +726,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-identity-profile
Update Identity Profile
Update identity profile
Update a specified identity profile with this PATCH request.
You cannot update these fields:
@@ -780,7 +780,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Identity Profile
# Update identity profile
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -53,16 +53,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-lifecycle-state**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State
[**delete-lifecycle-state**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State
[**get-lifecycle-state**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State
[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates
[**set-lifecycle-state**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State
[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
[**create-lifecycle-state**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state
[**delete-lifecycle-state**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state
[**get-lifecycle-state**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state
[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates
[**set-lifecycle-state**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state
[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state
## create-lifecycle-state
Create Lifecycle State
Create lifecycle state
Use this endpoint to create a lifecycle state.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-lifecycle-state)
@@ -130,7 +130,7 @@ with ApiClient(configuration) as api_client:
}''' # LifecycleState | Lifecycle state to be created.
try:
# Create Lifecycle State
# Create lifecycle state
new_lifecycle_state = LifecycleState.from_json(lifecycle_state)
results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state)
# Below is a request that includes all optional parameters
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-lifecycle-state
Delete Lifecycle State
Delete lifecycle state
Use this endpoint to delete the lifecycle state by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-lifecycle-state)
@@ -191,7 +191,7 @@ with ApiClient(configuration) as api_client:
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
try:
# Delete Lifecycle State
# Delete lifecycle state
results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
@@ -207,7 +207,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-lifecycle-state
Get Lifecycle State
Get lifecycle state
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-state)
@@ -252,7 +252,7 @@ with ApiClient(configuration) as api_client:
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
try:
# Get Lifecycle State
# Get lifecycle state
results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
@@ -268,7 +268,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-lifecycle-states
Lists LifecycleStates
Lists lifecyclestates
Use this endpoint to list all lifecycle states by their associated identity profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-states)
@@ -318,7 +318,7 @@ with ApiClient(configuration) as api_client:
sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
try:
# Lists LifecycleStates
# Lists lifecyclestates
results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
@@ -335,7 +335,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-lifecycle-state
Set Lifecycle State
Set lifecycle state
Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-lifecycle-state)
@@ -381,7 +381,7 @@ with ApiClient(configuration) as api_client:
set_lifecycle_state_request = '''sailpoint.v3.SetLifecycleStateRequest()''' # SetLifecycleStateRequest |
try:
# Set Lifecycle State
# Set lifecycle state
new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request)
results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request)
# Below is a request that includes all optional parameters
@@ -397,7 +397,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-lifecycle-states
Update Lifecycle State
Update lifecycle state
Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-lifecycle-states)
@@ -445,7 +445,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
try:
# Update Lifecycle State
# Update lifecycle state
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration
[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method
[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method
[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method
[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration
[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration
[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method&#39;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&#39;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/v3/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/v3/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/v3/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/v3/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/v3/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/v3/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/v3/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/v3/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/V3/Methods/MFAControllerApi.md
View File

@@ -16,11 +16,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-send-token**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token
[**ping-verification-status**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest
[**send-duo-verify-request**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method
[**send-kba-answers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method
[**send-okta-verify-request**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**send-token-auth-request**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
[**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/v3/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/v3/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/v3/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/v3/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/v3/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

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

@@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-managed-client**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client
[**delete-managed-client**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client
[**get-managed-client**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client
[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status
[**get-managed-clients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients
[**update-managed-client**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client
[**create-managed-client**](#create-managed-client) | **POST** `/managed-clients` | Create managed client
[**delete-managed-client**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client
[**get-managed-client**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client
[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status
[**get-managed-clients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients
[**update-managed-client**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client
## create-managed-client
Create Managed Client
Create managed client
Create a new managed client.
The API returns a result that includes the managed client ID.
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
}''' # ManagedClientRequest |
try:
# Create Managed Client
# Create managed client
new_managed_client_request = ManagedClientRequest.from_json(managed_client_request)
results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request)
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-managed-client
Delete Managed Client
Delete managed client
Delete an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-client)
@@ -132,7 +132,7 @@ with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Delete Managed Client
# Delete managed client
ManagedClientsApi(api_client).delete_managed_client(id=id)
# Below is a request that includes all optional parameters
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-client
Get Managed Client
Get managed client
Get managed client by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client)
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Get Managed Client
# Get managed client
results = ManagedClientsApi(api_client).get_managed_client(id=id)
# Below is a request that includes all optional parameters
@@ -205,7 +205,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-client-status
Get Managed Client Status
Get managed client status
Get a managed client's status, using its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client-status)
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for.
try:
# Get Managed Client Status
# Get managed client status
results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type)
# Below is a request that includes all optional parameters
@@ -267,7 +267,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-clients
Get Managed Clients
Get managed clients
List managed clients.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clients)
@@ -315,7 +315,7 @@ with ApiClient(configuration) as api_client:
filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional)
try:
# Get Managed Clients
# Get managed clients
results = ManagedClientsApi(api_client).get_managed_clients()
# Below is a request that includes all optional parameters
@@ -332,7 +332,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-managed-client
Update Managed Client
Update managed client
Update an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-client)
@@ -378,7 +378,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object.
try:
# Update Managed Client
# Update managed client
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

42
docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md
View File

@@ -17,17 +17,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-managed-cluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster
[**delete-managed-cluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster
[**get-client-log-configuration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration
[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster
[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters
[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
[**create-managed-cluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create create managed cluster
[**delete-managed-cluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete managed cluster
[**get-client-log-configuration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration
[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get managed cluster
[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get managed clusters
[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration
[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update managed cluster
## create-managed-cluster
Create Create Managed Cluster
Create create managed cluster
Create a new Managed Cluster.
The API returns a result that includes the managed cluster ID.
@@ -79,7 +79,7 @@ with ApiClient(configuration) as api_client:
}''' # ManagedClusterRequest |
try:
# Create Create Managed Cluster
# Create create managed cluster
new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request)
results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request)
# Below is a request that includes all optional parameters
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-managed-cluster
Delete Managed Cluster
Delete managed cluster
Delete an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-cluster)
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False)
try:
# Delete Managed Cluster
# Delete managed cluster
ManagedClustersApi(api_client).delete_managed_cluster(id=id)
# Below is a request that includes all optional parameters
@@ -152,7 +152,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-client-log-configuration
Get Managed Cluster Log Configuration
Get managed cluster log configuration
Get a managed cluster's log configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-client-log-configuration)
@@ -196,7 +196,7 @@ with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for.
try:
# Get Managed Cluster Log Configuration
# Get managed cluster log configuration
results = ManagedClustersApi(api_client).get_client_log_configuration(id=id)
# Below is a request that includes all optional parameters
@@ -212,7 +212,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-cluster
Get Managed Cluster
Get managed cluster
Get a managed cluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-cluster)
@@ -255,7 +255,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
try:
# Get Managed Cluster
# Get managed cluster
results = ManagedClustersApi(api_client).get_managed_cluster(id=id)
# Below is a request that includes all optional parameters
@@ -271,7 +271,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-managed-clusters
Get Managed Clusters
Get managed clusters
List current organization's managed clusters, based on request context.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clusters)
@@ -319,7 +319,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:
# Get Managed Clusters
# Get managed clusters
results = ManagedClustersApi(api_client).get_managed_clusters()
# Below is a request that includes all optional parameters
@@ -336,7 +336,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-client-log-configuration
Update Managed Cluster Log Configuration
Update managed cluster log configuration
Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-client-log-configuration)
@@ -382,7 +382,7 @@ with ApiClient(configuration) as api_client:
put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster.
try:
# Update Managed Cluster Log Configuration
# Update managed cluster log configuration
new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request)
results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request)
# Below is a request that includes all optional parameters
@@ -398,7 +398,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-managed-cluster
Update Managed Cluster
Update managed cluster
Update an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-cluster)
@@ -444,7 +444,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object.
try:
# Update Managed Cluster
# Update managed cluster
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -46,42 +46,42 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request
[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record
[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request
[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source
[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source
[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record
[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records
[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request
[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source
[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source
[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source
[**export-non-employee-records**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV
[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template
[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request
[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record
[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request
[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source
[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source
[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record
[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records
[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request
[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source
[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source
[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source
[**export-non-employee-records**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv
[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template
[**get-non-employee-approval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail
[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests
[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests
[**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source
[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record
[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request
[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests
[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source
[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source
[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source
[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records
[**list-non-employee-approvals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests
[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records
[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests
[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources
[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record
[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source
[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source
[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record
[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record
[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request
[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests
[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source
[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source
[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source
[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records
[**list-non-employee-approvals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests
[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records
[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests
[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources
[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record
[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source
[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source
[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request
[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record
## approve-non-employee-request
Approve a Non-Employee Request
Approve a non-employee request
Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request)
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeApprovalDecision |
try:
# Approve a Non-Employee Request
# Approve a non-employee request
new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision)
results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision)
# Below is a request that includes all optional parameters
@@ -144,7 +144,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-record
Create Non-Employee Record
Create non-employee record
This request will create a non-employee record.
Requires role context of `idn:nesr:create`
@@ -201,7 +201,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRequestBody | Non-Employee record creation request body.
try:
# Create Non-Employee Record
# Create non-employee record
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
@@ -217,7 +217,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-request
Create Non-Employee Request
Create non-employee request
This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request)
@@ -273,7 +273,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRequestBody | Non-Employee creation request body
try:
# Create Non-Employee Request
# Create non-employee request
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
@@ -289,7 +289,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-source
Create Non-Employee Source
Create non-employee source
Create a non-employee source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source)
@@ -357,7 +357,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body.
try:
# Create Non-Employee Source
# Create non-employee source
new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body)
# Below is a request that includes all optional parameters
@@ -373,7 +373,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-non-employee-source-schema-attributes
Create a new Schema Attribute for Non-Employee Source
Create a new schema attribute for non-employee source
This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response.
Requires role context of `idn:nesr:create`
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeSchemaAttributeBody |
try:
# Create a new Schema Attribute for Non-Employee Source
# Create a new schema attribute for non-employee source
new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body)
# Below is a request that includes all optional parameters
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-record
Delete Non-Employee Record
Delete non-employee record
This request will delete a non-employee record.
Requires role context of `idn:nesr:delete`
@@ -484,7 +484,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID)
try:
# Delete Non-Employee Record
# Delete non-employee record
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id)
# Below is a request that includes all optional parameters
@@ -498,7 +498,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-records-in-bulk
Delete Multiple Non-Employee Records
Delete multiple non-employee records
This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk)
@@ -540,7 +540,7 @@ with ApiClient(configuration) as api_client:
delete_non_employee_records_in_bulk_request = '''sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest()''' # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body.
try:
# Delete Multiple Non-Employee Records
# Delete multiple non-employee records
new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request)
# Below is a request that includes all optional parameters
@@ -554,7 +554,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-request
Delete Non-Employee Request
Delete non-employee request
This request will delete a non-employee request.
Requires role context of `idn:nesr:delete`
@@ -597,7 +597,7 @@ with ApiClient(configuration) as api_client:
id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format
try:
# Delete Non-Employee Request
# Delete non-employee request
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id)
# Below is a request that includes all optional parameters
@@ -611,7 +611,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-schema-attribute
Delete a Schema Attribute for Non-Employee Source
Delete a schema attribute for non-employee source
This end-point deletes a specific schema attribute for a non-employee source.
Requires role context of `idn:nesr:delete`
@@ -656,7 +656,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# Delete a Schema Attribute for Non-Employee Source
# Delete a schema attribute for non-employee source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id)
# Below is a request that includes all optional parameters
@@ -670,7 +670,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-source
Delete Non-Employee Source
Delete non-employee source
This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source)
@@ -711,7 +711,7 @@ with ApiClient(configuration) as api_client:
source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id
try:
# Delete Non-Employee Source
# Delete non-employee source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -725,7 +725,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-non-employee-source-schema-attributes
Delete all custom schema attributes for Non-Employee Source
Delete all custom schema attributes for non-employee source
This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes)
@@ -766,7 +766,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# Delete all custom schema attributes for Non-Employee Source
# Delete all custom schema attributes for non-employee source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -780,7 +780,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-non-employee-records
Exports Non-Employee Records to CSV
Exports non-employee records to csv
This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-records)
@@ -822,7 +822,7 @@ with ApiClient(configuration) as api_client:
id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID)
try:
# Exports Non-Employee Records to CSV
# Exports non-employee records to csv
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id)
# Below is a request that includes all optional parameters
@@ -836,7 +836,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## export-non-employee-source-schema-template
Exports Source Schema Template
Exports source schema template
This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-source-schema-template)
@@ -878,7 +878,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID)
try:
# Exports Source Schema Template
# Exports source schema template
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id)
# Below is a request that includes all optional parameters
@@ -955,7 +955,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-approval-summary
Get Summary of Non-Employee Approval Requests
Get summary of non-employee approval requests
This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.
@@ -1001,7 +1001,7 @@ with ApiClient(configuration) as api_client:
requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.
try:
# Get Summary of Non-Employee Approval Requests
# Get summary of non-employee approval requests
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for)
# Below is a request that includes all optional parameters
@@ -1077,7 +1077,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-record
Get a Non-Employee Record
Get a non-employee record
This gets a non-employee record.
Requires role context of `idn:nesr:read`
@@ -1120,7 +1120,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID)
try:
# Get a Non-Employee Record
# Get a non-employee record
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id)
# Below is a request that includes all optional parameters
@@ -1136,7 +1136,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-request
Get a Non-Employee Request
Get a non-employee request
This gets a non-employee request.
There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in this case the user
@@ -1183,7 +1183,7 @@ with ApiClient(configuration) as api_client:
id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID)
try:
# Get a Non-Employee Request
# Get a non-employee request
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id)
# Below is a request that includes all optional parameters
@@ -1199,7 +1199,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-request-summary
Get Summary of Non-Employee Requests
Get summary of non-employee requests
This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.
@@ -1245,7 +1245,7 @@ with ApiClient(configuration) as api_client:
requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.
try:
# Get Summary of Non-Employee Requests
# Get summary of non-employee requests
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for)
# Below is a request that includes all optional parameters
@@ -1261,7 +1261,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-schema-attribute
Get Schema Attribute Non-Employee Source
Get schema attribute non-employee source
This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute)
@@ -1305,7 +1305,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# Get Schema Attribute Non-Employee Source
# Get schema attribute non-employee source
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1321,7 +1321,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-source
Get a Non-Employee Source
Get a non-employee source
This gets a non-employee source. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request any source.
@@ -1367,7 +1367,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id
try:
# Get a Non-Employee Source
# Get a non-employee source
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1383,7 +1383,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-non-employee-source-schema-attributes
List Schema Attributes Non-Employee Source
List schema attributes non-employee source
This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.
Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
@@ -1427,7 +1427,7 @@ with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id
try:
# List Schema Attributes Non-Employee Source
# List schema attributes non-employee source
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -1444,7 +1444,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-non-employee-records-in-bulk
Imports, or Updates, Non-Employee Records
Imports, or updates, non-employee records
This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk)
@@ -1489,7 +1489,7 @@ with ApiClient(configuration) as api_client:
data = None # bytearray | # bytearray |
try:
# Imports, or Updates, Non-Employee Records
# Imports, or updates, non-employee records
results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data)
# Below is a request that includes all optional parameters
@@ -1505,7 +1505,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-approvals
Get List of Non-Employee Approval Requests
Get list of non-employee approval requests
This gets a list of non-employee approval requests.
There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in which case they
@@ -1561,7 +1561,7 @@ with ApiClient(configuration) as api_client:
sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
try:
# Get List of Non-Employee Approval Requests
# Get list of non-employee approval requests
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals()
# Below is a request that includes all optional parameters
@@ -1578,7 +1578,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-records
List Non-Employee Records
List non-employee records
This gets a list of non-employee records. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.
2. The user is an account manager, in which case they can get a list of the non-employees that they manage.
@@ -1630,7 +1630,7 @@ with ApiClient(configuration) as api_client:
filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional)
try:
# List Non-Employee Records
# List non-employee records
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records()
# Below is a request that includes all optional parameters
@@ -1647,7 +1647,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-requests
List Non-Employee Requests
List non-employee requests
This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
@@ -1703,7 +1703,7 @@ with ApiClient(configuration) as api_client:
filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional)
try:
# List Non-Employee Requests
# List non-employee requests
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for)
# Below is a request that includes all optional parameters
@@ -1720,7 +1720,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-non-employee-sources
List Non-Employee Sources
List non-employee sources
Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter:
1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`.
2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns.
@@ -1774,7 +1774,7 @@ with ApiClient(configuration) as api_client:
sorters = 'name,created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional)
try:
# List Non-Employee Sources
# List non-employee sources
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources()
# Below is a request that includes all optional parameters
@@ -1791,7 +1791,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-record
Patch Non-Employee Record
Patch non-employee record
This request will patch a non-employee record. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:update`, in which case they
update all available fields.
@@ -1841,7 +1841,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
try:
# Patch Non-Employee Record
# Patch non-employee record
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1857,7 +1857,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-schema-attribute
Patch a Schema Attribute for Non-Employee Source
Patch a schema attribute for non-employee source
This end-point patches a specific schema attribute for a non-employee SourceId.
Requires role context of `idn:nesr:update`
@@ -1907,7 +1907,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/label, value={new attribute label=null}}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
try:
# Patch a Schema Attribute for Non-Employee Source
# Patch a schema attribute for non-employee source
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1923,7 +1923,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-non-employee-source
Patch a Non-Employee Source
Patch a non-employee source
patch a non-employee source. (partial update) <br/> Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source)
@@ -1968,7 +1968,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Patch a Non-Employee Source
# Patch a non-employee source
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -1984,7 +1984,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-non-employee-request
Reject a Non-Employee Request
Reject a non-employee request
This endpoint will reject an approval item request and notify user. The current user must be the requested approver.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request)
@@ -2031,7 +2031,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRejectApprovalDecision |
try:
# Reject a Non-Employee Request
# Reject a non-employee request
new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision)
results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision)
# Below is a request that includes all optional parameters
@@ -2047,7 +2047,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-non-employee-record
Update Non-Employee Record
Update non-employee record
This request will update a non-employee record. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:update`, in which case they
update all available fields.
@@ -2110,7 +2110,7 @@ with ApiClient(configuration) as api_client:
}''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
try:
# Update Non-Employee Record
# Update non-employee record
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters

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

@@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-oauth-client**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client
[**delete-oauth-client**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client
[**get-oauth-client**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client
[**list-oauth-clients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**patch-oauth-client**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
[**create-oauth-client**](#create-oauth-client) | **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/v3/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/v3/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/v3/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/v3/list-oauth-clients)
@@ -258,7 +258,7 @@ with ApiClient(configuration) as api_client:
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
try:
# List OAuth Clients
# List oauth clients
results = OAuthClientsApi(api_client).list_oauth_clients()
# Below is a request that includes all optional parameters
@@ -275,7 +275,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-oauth-client
Patch OAuth Client
Patch oauth client
This performs a targeted update to the field(s) of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-oauth-client)
@@ -321,7 +321,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
try:
# Patch OAuth Client
# Patch oauth client
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

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

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

@@ -39,13 +39,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-password-change-status**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status
[**query-password-info**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**set-password**](#set-password) | **POST** `/set-password` | Set Identity&#39;s Password
[**get-password-change-status**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status
[**query-password-info**](#query-password-info) | **POST** `/query-password-info` | Query password info
[**set-password**](#set-password) | **POST** `/set-password` | Set identity&#39;s password
## get-password-change-status
Get Password Change Request Status
Get password change request status
This API returns the status of a password change request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-change-status)
@@ -88,7 +88,7 @@ with ApiClient(configuration) as api_client:
id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID
try:
# Get Password Change Request Status
# Get password change request status
results = PasswordManagementApi(api_client).get_password_change_status(id=id)
# Below is a request that includes all optional parameters
@@ -104,7 +104,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.
@@ -151,7 +151,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
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-password
Set Identity's Password
Set identity's password
This API is used to set a password for an identity.
An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).
@@ -235,7 +235,7 @@ with ApiClient(configuration) as api_client:
}''' # PasswordChangeRequest |
try:
# Set Identity's Password
# Set identity's password
new_password_change_request = PasswordChangeRequest.from_json(password_change_request)
results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request)
# Below is a request that includes all optional parameters

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

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

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

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

@@ -26,14 +26,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-personal-access-token**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token
[**delete-personal-access-token**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token
[**list-personal-access-tokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**patch-personal-access-token**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
[**create-personal-access-token**](#create-personal-access-token) | **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/v3/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/v3/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/v3/list-personal-access-tokens)
@@ -196,7 +196,7 @@ with ApiClient(configuration) as api_client:
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
try:
# List Personal Access Tokens
# List personal access tokens
results = PersonalAccessTokensApi(api_client).list_personal_access_tokens()
# Below is a request that includes all optional parameters
@@ -213,7 +213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-personal-access-token
Patch Personal Access Token
Patch personal access token
This performs a targeted update to the field(s) of a Personal Access Token.
Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
try:
# Patch Personal Access Token
# Patch personal access token
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -25,12 +25,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration
[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration
[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the public identities configuration
[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the public identities configuration
## get-public-identity-config
Get the Public Identities Configuration
Get the public identities configuration
Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identity-config)
@@ -68,7 +68,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the Public Identities Configuration
# Get the public identities configuration
results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
# Below is a request that includes all optional parameters
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-public-identity-config
Update the Public Identities Configuration
Update the public identities configuration
Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config)
@@ -140,7 +140,7 @@ with ApiClient(configuration) as api_client:
}''' # PublicIdentityConfig |
try:
# Update the Public Identities Configuration
# Update the public identities configuration
new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config)
results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config)
# Below is a request that includes all optional parameters

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

@@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel-report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report
[**get-report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File
[**get-report-result**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
[**start-report**](#start-report) | **POST** `/reports/run` | Run Report
[**cancel-report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel report
[**get-report**](#get-report) | **GET** `/reports/{taskResultId}` | Get report file
[**get-report-result**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get report result
[**start-report**](#start-report) | **POST** `/reports/run` | Run report
## cancel-report
Cancel Report
Cancel report
Cancels a running report.
[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-report)
@@ -66,7 +66,7 @@ with ApiClient(configuration) as api_client:
id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel
try:
# Cancel Report
# Cancel report
ReportsDataExtractionApi(api_client).cancel_report(id=id)
# Below is a request that includes all optional parameters
@@ -80,7 +80,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-report
Get Report File
Get report file
Gets a report in file format.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report)
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False)
try:
# Get Report File
# Get report file
results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format)
# Below is a request that includes all optional parameters
@@ -144,7 +144,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-report-result
Get Report Result
Get report result
Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report-result)
@@ -188,7 +188,7 @@ with ApiClient(configuration) as api_client:
completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False)
try:
# Get Report Result
# Get report result
results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id)
# Below is a request that includes all optional parameters
@@ -204,7 +204,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-report
Run Report
Run report
Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-report)
@@ -253,7 +253,7 @@ with ApiClient(configuration) as api_client:
}''' # ReportDetails |
try:
# Run Report
# Run report
new_report_details = ReportDetails.from_json(report_details)
results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details)
# Below is a request that includes all optional parameters

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

@@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**list-requestable-objects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
[**list-requestable-objects**](#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

42
docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md
View File

@@ -52,17 +52,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-role**](#create-role) | **POST** `/roles` | Create a Role
[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s)
[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete Role
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get Role
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role
[**list-roles**](#list-roles) | **GET** `/roles` | List Roles
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch 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 role
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get role
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List identities assigned a role
[**list-roles**](#list-roles) | **GET** `/roles` | List roles
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch role
## create-role
Create a Role
Create a role
This API creates a role.
In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves.
@@ -265,7 +265,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
@@ -281,7 +281,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.
@@ -329,7 +329,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
@@ -345,7 +345,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-role
Delete Role
Delete role
Delete a role by ID.
A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
@@ -388,7 +388,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID.
try:
# Delete Role
# Delete role
RolesApi(api_client).delete_role(id=id)
# Below is a request that includes all optional parameters
@@ -402,7 +402,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role
Get Role
Get role
Get a role by ID.
A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of.
@@ -445,7 +445,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID.
try:
# Get Role
# Get role
results = RolesApi(api_client).get_role(id=id)
# Below is a request that includes all optional parameters
@@ -461,7 +461,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role-assigned-identities
List Identities assigned a Role
List identities assigned a role
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities)
@@ -513,7 +513,7 @@ with ApiClient(configuration) as api_client:
sorters = 'aliasName,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional)
try:
# List Identities assigned a Role
# List identities assigned a role
results = RolesApi(api_client).get_role_assigned_identities(id=id)
# Below is a request that includes all optional parameters
@@ -530,7 +530,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-roles
List Roles
List roles
This API returns a list of Roles.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles)
@@ -586,7 +586,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
@@ -603,7 +603,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-role
Patch Role
Patch role
Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
* name
@@ -667,7 +667,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 Role
# Patch 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

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

@@ -41,27 +41,27 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-sod-policy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy
[**delete-sod-policy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID
[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule
[**create-sod-policy**](#create-sod-policy) | **POST** `/sod-policies` | Create sod policy
[**delete-sod-policy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete sod policy by id
[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete sod policy schedule
[**get-custom-violation-report**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report
[**get-default-violation-report**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report
[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status
[**get-sod-policy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID
[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule
[**get-sod-policy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get sod policy by id
[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get sod policy schedule
[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status
[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status
[**list-sod-policies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies
[**patch-sod-policy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID
[**put-policy-schedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule
[**put-sod-policy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID
[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID
[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status
[**list-sod-policies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies
[**patch-sod-policy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch sod policy by id
[**put-policy-schedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule
[**put-sod-policy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id
[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by id
[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report
## create-sod-policy
Create SOD policy
Create sod policy
This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.
Requires role of ORG_ADMIN.
@@ -159,7 +159,7 @@ with ApiClient(configuration) as api_client:
}''' # SodPolicy |
try:
# Create SOD policy
# Create sod policy
new_sod_policy = SodPolicy.from_json(sod_policy)
results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy)
# Below is a request that includes all optional parameters
@@ -175,7 +175,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-sod-policy
Delete SOD policy by ID
Delete sod policy by id
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -220,7 +220,7 @@ with ApiClient(configuration) as api_client:
logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True)
try:
# Delete SOD policy by ID
# Delete sod policy by id
SODPoliciesApi(api_client).delete_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -234,7 +234,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-sod-policy-schedule
Delete SOD policy schedule
Delete sod policy schedule
This deletes schedule for a specified SOD policy by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule)
@@ -276,7 +276,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for.
try:
# Delete SOD policy schedule
# Delete sod policy schedule
SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -462,7 +462,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sod-policy
Get SOD policy by ID
Get sod policy by id
This gets specified SOD policy.
Requires role of ORG_ADMIN.
@@ -506,7 +506,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve.
try:
# Get SOD policy by ID
# Get sod policy by id
results = SODPoliciesApi(api_client).get_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -522,7 +522,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sod-policy-schedule
Get SOD policy schedule
Get sod policy schedule
This endpoint gets a specified SOD policy's schedule.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule)
@@ -564,7 +564,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve.
try:
# Get SOD policy schedule
# Get sod policy schedule
results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
@@ -639,7 +639,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sod-violation-report-status
Get SOD violation report status
Get sod violation report status
This gets the status for a violation report run task that has already been invoked.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status)
@@ -682,7 +682,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for.
try:
# Get SOD violation report status
# Get sod violation report status
results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id)
# Below is a request that includes all optional parameters
@@ -698,7 +698,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-sod-policies
List SOD policies
List sod policies
This gets list of all SOD policies.
Requires role of ORG_ADMIN
@@ -749,7 +749,7 @@ with ApiClient(configuration) as api_client:
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional)
try:
# List SOD policies
# List sod policies
results = SODPoliciesApi(api_client).list_sod_policies()
# Below is a request that includes all optional parameters
@@ -766,7 +766,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-sod-policy
Patch SOD policy by ID
Patch sod policy by id
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Requires role of ORG_ADMIN.
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
@@ -814,7 +814,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
try:
# Patch SOD policy by ID
# Patch sod policy by id
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -830,7 +830,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-policy-schedule
Update SOD Policy schedule
Update sod policy schedule
This updates schedule for a specified SOD policy.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule)
@@ -911,7 +911,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
@@ -927,7 +927,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-sod-policy
Update SOD policy by ID
Update sod policy by id
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -1028,7 +1028,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
@@ -1044,7 +1044,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-evaluate-sod-policy
Evaluate one policy by ID
Evaluate one policy by id
Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy)
@@ -1086,7 +1086,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Evaluate one policy by ID
# Evaluate one policy by id
results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id)
# Below is a request that includes all optional parameters
@@ -1163,7 +1163,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-sod-policy
Runs SOD policy violation report
Runs sod policy violation report
This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy)
@@ -1206,7 +1206,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Runs SOD policy violation report
# Runs sod policy violation report
results = SODPoliciesApi(api_client).start_sod_policy(id=id)
# Below is a request that includes all optional parameters

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

@@ -33,12 +33,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**start-violation-check**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations
[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity.
[**start-violation-check**](#start-violation-check) | **POST** `/sod-violations/check` | Check sod violations
## start-predict-sod-violations
Predict SOD violations for identity.
Predict sod violations for identity.
This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations)
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentityWithNewAccess |
try:
# Predict SOD violations for identity.
# Predict sod violations for identity.
new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access)
results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access)
# Below is a request that includes all optional parameters
@@ -109,7 +109,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-violation-check
Check SOD violations
Check sod violations
This API initiates a SOD policy verification asynchronously.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check)
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 |
try:
# Check SOD violations
# Check sod violations
new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1)
results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1)
# Below is a request that includes all optional parameters

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

@@ -26,10 +26,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-saved-search**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search
[**delete-saved-search**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID
[**execute-saved-search**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID
[**get-saved-search**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID
[**list-saved-searches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches
[**delete-saved-search**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by id
[**execute-saved-search**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by id
[**get-saved-search**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by id
[**list-saved-searches**](#list-saved-searches) | **GET** `/saved-searches` | A list of saved searches
[**put-saved-search**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search
@@ -94,7 +94,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-saved-search
Delete document by ID
Delete document by id
Deletes the specified saved search.
@@ -137,7 +137,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Delete document by ID
# Delete document by id
SavedSearchApi(api_client).delete_saved_search(id=id)
# Below is a request that includes all optional parameters
@@ -151,7 +151,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## execute-saved-search
Execute a saved search by ID
Execute a saved search by id
Executes the specified saved search.
@@ -207,7 +207,7 @@ with ApiClient(configuration) as api_client:
}''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided.
try:
# Execute a saved search by ID
# Execute a saved search by id
new_search_arguments = SearchArguments.from_json(search_arguments)
SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments)
# Below is a request that includes all optional parameters
@@ -221,7 +221,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-saved-search
Return saved search by ID
Return saved search by id
Returns the specified saved search.
@@ -265,7 +265,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Return saved search by ID
# Return saved search by id
results = SavedSearchApi(api_client).get_saved_search(id=id)
# Below is a request that includes all optional parameters
@@ -281,7 +281,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-saved-searches
A list of Saved Searches
A list of saved searches
Returns a list of saved searches.
@@ -330,7 +330,7 @@ with ApiClient(configuration) as api_client:
filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional)
try:
# A list of Saved Searches
# A list of saved searches
results = SavedSearchApi(api_client).list_saved_searches()
# Below is a request that includes all optional parameters

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

@@ -42,11 +42,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-scheduled-search**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search
[**delete-scheduled-search**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search
[**get-scheduled-search**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search
[**delete-scheduled-search**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a scheduled search
[**get-scheduled-search**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a scheduled search
[**list-scheduled-search**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches
[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search
[**update-scheduled-search**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search
[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search
[**update-scheduled-search**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing scheduled search
## create-scheduled-search
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-scheduled-search
Delete a Scheduled Search
Delete a scheduled search
Deletes the specified scheduled search.
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Delete a Scheduled Search
# Delete a scheduled search
ScheduledSearchApi(api_client).delete_scheduled_search(id=id)
# Below is a request that includes all optional parameters
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-scheduled-search
Get a Scheduled Search
Get a scheduled search
Returns the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-scheduled-search)
@@ -211,7 +211,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Scheduled Search
# Get a scheduled search
results = ScheduledSearchApi(api_client).get_scheduled_search(id=id)
# Below is a request that includes all optional parameters
@@ -294,7 +294,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## unsubscribe-scheduled-search
Unsubscribe a recipient from Scheduled Search
Unsubscribe a recipient from scheduled search
Unsubscribes a recipient from the specified scheduled search.
@@ -340,7 +340,7 @@ with ApiClient(configuration) as api_client:
}''' # TypedReference | The recipient to be removed from the scheduled search.
try:
# Unsubscribe a recipient from Scheduled Search
# Unsubscribe a recipient from scheduled search
new_typed_reference = TypedReference.from_json(typed_reference)
ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference)
# Below is a request that includes all optional parameters
@@ -354,7 +354,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-scheduled-search
Update an existing Scheduled Search
Update an existing scheduled search
Updates an existing scheduled search.
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
}''' # ScheduledSearch | The scheduled search to persist.
try:
# Update an existing Scheduled Search
# Update an existing scheduled search
new_scheduled_search = ScheduledSearch.from_json(scheduled_search)
results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search)
# Below is a request that includes all optional parameters

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

@@ -38,14 +38,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**search-aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation
[**search-count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query
[**search-get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID
[**search-post**](#search-post) | **POST** `/search` | Perform Search
[**search-aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a search query aggregation
[**search-count**](#search-count) | **POST** `/search/count` | Count documents satisfying a query
[**search-get**](#search-get) | **GET** `/search/{index}/{id}` | Get a document by id
[**search-post**](#search-post) | **POST** `/search` | Perform search
## search-aggregate
Perform a Search Query Aggregation
Perform a search query aggregation
Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-aggregate)
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# Perform a Search Query Aggregation
# Perform a search query aggregation
new_search = Search.from_json(search)
results = SearchApi(api_client).search_aggregate(search=new_search)
# Below is a request that includes all optional parameters
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-count
Count Documents Satisfying a Query
Count documents satisfying a query
Performs a search with a provided query and returns the count of results in the X-Total-Count header.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-count)
@@ -384,7 +384,7 @@ with ApiClient(configuration) as api_client:
}''' # Search |
try:
# Count Documents Satisfying a Query
# Count documents satisfying a query
new_search = Search.from_json(search)
SearchApi(api_client).search_count(search=new_search)
# Below is a request that includes all optional parameters
@@ -398,7 +398,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-get
Get a Document by ID
Get a document by id
Fetches a single document from the specified index, using the specified document ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-get)
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Document by ID
# Get a document by id
results = SearchApi(api_client).search_get(index=index, id=id)
# Below is a request that includes all optional parameters
@@ -458,7 +458,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## search-post
Perform Search
Perform search
Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-post)
@@ -622,7 +622,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# Perform Search
# Perform search
new_search = Search.from_json(search)
results = SearchApi(api_client).search_post(search=new_search)
# Below is a request that includes all optional parameters

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

@@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes
[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute
[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes
[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
[**create-search-attribute-config**](#create-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/v3/delete-search-attribute-config)
@@ -150,7 +150,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
@@ -164,7 +164,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).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config)
@@ -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/v3/get-single-search-attribute-config)
@@ -269,7 +269,7 @@ with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve.
try:
# Get Extended Search Attribute
# Get extended search attribute
results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name)
# Below is a request that includes all optional parameters
@@ -286,7 +286,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
@@ -334,7 +334,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/V3/Methods/SegmentsApi.md
View File

@@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-segment**](#create-segment) | **POST** `/segments` | Create Segment
[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID
[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID
[**list-segments**](#list-segments) | **GET** `/segments` | List Segments
[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
[**create-segment**](#create-segment) | **POST** `/segments` | Create segment
[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id
[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id
[**list-segments**](#list-segments) | **GET** `/segments` | List segments
[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment
## create-segment
Create Segment
Create segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
}''' # Segment |
try:
# Create Segment
# Create segment
new_segment = Segment.from_json(segment)
results = SegmentsApi(api_client).create_segment(segment=new_segment)
# Below is a request that includes all optional parameters
@@ -122,7 +122,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-segment
Delete Segment by ID
Delete segment by id
This API deletes the segment specified by the given ID.
>**Note:** that segment deletion may take some time to become effective.
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete.
try:
# Delete Segment by ID
# Delete segment by id
SegmentsApi(api_client).delete_segment(id=id)
# Below is a request that includes all optional parameters
@@ -179,7 +179,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-segment
Get Segment by ID
Get segment by id
This API returns the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-segment)
@@ -222,7 +222,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve.
try:
# Get Segment by ID
# Get segment by id
results = SegmentsApi(api_client).get_segment(id=id)
# Below is a request that includes all optional parameters
@@ -238,7 +238,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-segments
List Segments
List segments
This API returns a list of all segments.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-segments)
@@ -284,7 +284,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# List Segments
# List segments
results = SegmentsApi(api_client).list_segments()
# Below is a request that includes all optional parameters
@@ -301,7 +301,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-segment
Update Segment
Update segment
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
>**Note:** Changes to a segment may take some time to propagate to all identities.
@@ -347,7 +347,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
try:
# Update Segment
# Update segment
new_request_body = RequestBody.from_json(request_body)
results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters

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

@@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration
[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration
[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration
[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName
[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types
[**get-service-desk-integrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations
[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration
[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration
[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration
[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname
[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types
[**get-service-desk-integrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing service desk integrations
[**get-status-check-details**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration
[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration
[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration
[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration
[**update-status-check-details**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
## create-service-desk-integration
Create new Service Desk integration
Create new service desk integration
Create a new Service Desk integration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-service-desk-integration)
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
}''' # ServiceDeskIntegrationDto | The specifics of a new integration to create
try:
# Create new Service Desk integration
# Create new service desk integration
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
@@ -144,7 +144,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-service-desk-integration
Delete a Service Desk integration
Delete a service desk integration
Delete an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-service-desk-integration)
@@ -186,7 +186,7 @@ with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete
try:
# Delete a Service Desk integration
# Delete a service desk integration
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id)
# Below is a request that includes all optional parameters
@@ -200,7 +200,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration
Get a Service Desk integration
Get a service desk integration
Get an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration)
@@ -243,7 +243,7 @@ with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get
try:
# Get a Service Desk integration
# Get a service desk integration
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id)
# Below is a request that includes all optional parameters
@@ -259,7 +259,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration-template
Service Desk integration template by scriptName
Service desk integration template by scriptname
This API endpoint returns an existing Service Desk integration template by scriptName.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-template)
@@ -302,7 +302,7 @@ with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get
try:
# Service Desk integration template by scriptName
# Service desk integration template by scriptname
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -318,7 +318,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integration-types
List Service Desk integration types
List service desk integration types
This API endpoint returns the current list of supported Service Desk integration types.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-types)
@@ -357,7 +357,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Service Desk integration types
# List service desk integration types
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
# Below is a request that includes all optional parameters
@@ -374,7 +374,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-service-desk-integrations
List existing Service Desk integrations
List existing service desk integrations
Get a list of Service Desk integration objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integrations)
@@ -425,7 +425,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# List existing Service Desk integrations
# List existing service desk integrations
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations()
# Below is a request that includes all optional parameters
@@ -497,7 +497,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-service-desk-integration
Patch a Service Desk Integration
Patch a service desk integration
Update an existing Service Desk integration by ID with a PATCH request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-service-desk-integration)
@@ -543,7 +543,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
try:
# Patch a Service Desk Integration
# Patch a service desk integration
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
@@ -559,7 +559,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-service-desk-integration
Update a Service Desk integration
Update a service desk integration
Update an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-service-desk-integration)
@@ -637,7 +637,7 @@ with ApiClient(configuration) as api_client:
}''' # ServiceDeskIntegrationDto | The specifics of the integration to update
try:
# Update a Service Desk integration
# Update a service desk integration
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto)
# Below is a request that includes all optional parameters

120
docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md
View File

@@ -72,36 +72,36 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow.
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType
[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID
[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID
[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id
[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id
[**get-accounts-schema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template
[**get-entitlements-schema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get source by id
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id
[**get-source-health**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id
[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID
[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source
[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id
[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source
[**import-accounts-schema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
[**import-connector-file**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
[**import-entitlements-schema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies
[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy
[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow.
[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update source (full)
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full)
[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies
[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy
[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial)
[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial)
## create-provisioning-policy
Create Provisioning Policy
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.
@@ -187,7 +187,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
@@ -203,7 +203,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-source
Creates a source in IdentityNow.
Creates a source in identitynow.
This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source)
@@ -329,7 +329,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
@@ -345,7 +345,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).
@@ -390,7 +390,7 @@ with ApiClient(configuration) as api_client:
model_schema = '''sailpoint.v3.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
@@ -406,7 +406,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/v3/delete-provisioning-policy)
@@ -451,7 +451,7 @@ with ApiClient(configuration) as api_client:
usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
try:
# Delete Provisioning Policy by UsageType
# 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
@@ -465,7 +465,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-source
Delete Source by ID
Delete source by id
Use this API to delete a specific source in Identity Security Cloud (ISC).
The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}`
@@ -509,7 +509,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Delete Source by ID
# Delete source by id
results = SourcesApi(api_client).delete_source(id=id)
# Below is a request that includes all optional parameters
@@ -525,7 +525,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/v3/delete-source-schema)
@@ -569,7 +569,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
@@ -700,7 +700,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/v3/get-provisioning-policy)
@@ -746,7 +746,7 @@ with ApiClient(configuration) as api_client:
usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
try:
# Get Provisioning Policy by UsageType
# 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
@@ -762,7 +762,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source
Get Source by ID
Get source by id
Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source)
@@ -805,7 +805,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
@@ -821,7 +821,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-connections
Get Source Connections by ID
Get source connections by id
Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-connections)
@@ -864,7 +864,7 @@ with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source Connections by ID
# Get source connections by id
results = SourcesApi(api_client).get_source_connections(source_id=source_id)
# Below is a request that includes all optional parameters
@@ -939,7 +939,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.
@@ -985,7 +985,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
@@ -1001,7 +1001,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/v3/get-source-schemas)
@@ -1048,7 +1048,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
@@ -1259,7 +1259,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/v3/list-provisioning-policies)
@@ -1302,7 +1302,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
@@ -1319,7 +1319,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-sources
Lists all sources in IdentityNow.
Lists all sources in identitynow.
This end-point lists all the sources in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sources)
@@ -1374,7 +1374,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
@@ -1391,7 +1391,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.
@@ -1480,7 +1480,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
@@ -1496,7 +1496,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:
@@ -1635,7 +1635,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
@@ -1651,7 +1651,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
@@ -1708,7 +1708,7 @@ with ApiClient(configuration) as api_client:
model_schema = '''sailpoint.v3.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
@@ -1724,7 +1724,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/v3/update-provisioning-policies-in-bulk)
@@ -1769,7 +1769,7 @@ with ApiClient(configuration) as api_client:
provisioning_policy_dto = '''[sailpoint.v3.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
@@ -1786,7 +1786,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.
@@ -1837,7 +1837,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
@@ -1853,7 +1853,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.
@@ -1914,7 +1914,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
@@ -1930,7 +1930,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:
@@ -2007,7 +2007,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
try:
# Update Source Schema (Partial)
# Update source schema (partial)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters

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

@@ -68,18 +68,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-tagged-object**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags
[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects
[**get-tagged-object**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object
[**list-tagged-objects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects
[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type
[**put-tagged-object**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object
[**set-tag-to-object**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
[**delete-tagged-object**](#delete-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/v3/delete-tagged-object)
@@ -122,7 +122,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object to delete tags from. # str | The ID of the object to delete tags from.
try:
# Delete Object Tags
# Delete object tags
TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id)
# Below is a request that includes all optional parameters
@@ -136,7 +136,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-tags-to-many-object
Remove Tags from Multiple Objects
Remove tags from multiple objects
This API removes tags from multiple objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tags-to-many-object)
@@ -189,7 +189,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Remove Tags from Multiple Objects
# Remove tags from multiple objects
new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object)
# Below is a request that includes all optional parameters
@@ -203,7 +203,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-tagged-object
Get Tagged Object
Get tagged object
This gets a tagged object for the specified type.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-tagged-object)
@@ -247,7 +247,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get Tagged Object
# Get tagged object
results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id)
# Below is a request that includes all optional parameters
@@ -263,7 +263,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-tagged-objects
List Tagged Objects
List tagged objects
This API returns a list of all tagged objects.
Any authenticated token may be used to call this API.
@@ -313,7 +313,7 @@ with ApiClient(configuration) as api_client:
filters = 'tagName eq \"BU_FINANCE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional)
try:
# List Tagged Objects
# List tagged objects
results = TaggedObjectsApi(api_client).list_tagged_objects()
# Below is a request that includes all optional parameters
@@ -330,7 +330,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-tagged-objects-by-type
List Tagged Objects by Type
List tagged objects by type
This API returns a list of all tagged objects by type.
Any authenticated token may be used to call this API.
@@ -382,7 +382,7 @@ with ApiClient(configuration) as api_client:
filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional)
try:
# List Tagged Objects by Type
# List tagged objects by type
results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type)
# Below is a request that includes all optional parameters
@@ -399,7 +399,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-tagged-object
Update Tagged Object
Update tagged object
This updates a tagged object for the specified type.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-tagged-object)
@@ -452,7 +452,7 @@ with ApiClient(configuration) as api_client:
}''' # TaggedObject |
try:
# Update Tagged Object
# Update tagged object
new_tagged_object = TaggedObject.from_json(tagged_object)
results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object)
# Below is a request that includes all optional parameters
@@ -468,7 +468,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-tag-to-object
Add Tag to Object
Add tag to object
This adds a tag to an object.
Any authenticated token may be used to call this API.
@@ -519,7 +519,7 @@ with ApiClient(configuration) as api_client:
}''' # TaggedObject |
try:
# Add Tag to Object
# Add tag to object
new_tagged_object = TaggedObject.from_json(tagged_object)
TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object)
# Below is a request that includes all optional parameters
@@ -533,7 +533,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-tags-to-many-objects
Tag Multiple Objects
Tag multiple objects
This API adds tags to multiple objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tags-to-many-objects)
@@ -588,7 +588,7 @@ with ApiClient(configuration) as api_client:
}''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Tag Multiple Objects
# Tag multiple objects
new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object)
results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object)
# Below is a request that includes all optional parameters

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

@@ -22,7 +22,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create-transform**](#create-transform) | **POST** `/transforms` | Create transform
[**delete-transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform
[**get-transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID
[**get-transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by id
[**list-transforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**update-transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
@@ -148,7 +148,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-transform
Transform by ID
Transform by id
This API returns the transform specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-transform)
@@ -191,7 +191,7 @@ with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve
try:
# Transform by ID
# Transform by id
results = TransformsApi(api_client).get_transform(id=id)
# Below is a request that includes all optional parameters

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

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

@@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item
[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary
[**list-work-items**](#list-work-items) | **GET** `/work-items` | List Work Items
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**send-work-item-forward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count work items
[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item
[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary
[**list-work-items**](#list-work-items) | **GET** `/work-items` | List work items
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items
[**send-work-item-forward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a work item
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections
## approve-approval-item
Approve an Approval Item
Approve an approval item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item)
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Approve an Approval Item
# Approve an approval item
results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## approve-approval-items-in-bulk
Bulk approve Approval Items
Bulk approve approval items
This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk)
@@ -149,7 +149,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk approve Approval Items
# Bulk approve approval items
results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## complete-work-item
Complete a Work Item
Complete a work item
This API completes a work item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item)
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional)
try:
# Complete a Work Item
# Complete a work item
results = WorkItemsApi(api_client).complete_work_item(id=id)
# Below is a request that includes all optional parameters
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-completed-work-items
Completed Work Items
Completed work items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items)
@@ -274,7 +274,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
@@ -291,7 +291,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-count-completed-work-items
Count Completed Work Items
Count completed work items
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items)
@@ -333,7 +333,7 @@ with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# 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
@@ -349,7 +349,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-count-work-items
Count Work Items
Count work items
This gets a count of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items)
@@ -391,7 +391,7 @@ with ApiClient(configuration) as api_client:
owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Work Items
# Count work items
results = WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
@@ -407,7 +407,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-work-item
Get a Work Item
Get a work item
This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item)
@@ -450,7 +450,7 @@ with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item.
try:
# Get a Work Item
# Get a work item
results = WorkItemsApi(api_client).get_work_item(id=id)
# Below is a request that includes all optional parameters
@@ -466,7 +466,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-work-items-summary
Work Items Summary
Work items summary
This gets a summary of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary)
@@ -508,7 +508,7 @@ with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Work Items Summary
# Work items summary
results = WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
@@ -524,7 +524,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-work-items
List Work Items
List work items
This gets a collection of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items)
@@ -572,7 +572,7 @@ with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# List Work Items
# List work items
results = WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
@@ -589,7 +589,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval-item
Reject an Approval Item
Reject an approval item
This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item)
@@ -634,7 +634,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
@@ -650,7 +650,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval-items-in-bulk
Bulk reject Approval Items
Bulk reject approval items
This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk)
@@ -693,7 +693,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
@@ -709,7 +709,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-work-item-forward
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. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward)
@@ -757,7 +757,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).send_work_item_forward(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
@@ -771,7 +771,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-account-selection
Submit Account Selections
Submit account selections
This API submits account selections. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection)
@@ -816,7 +816,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

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

@@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID
[**create-external-execute-workflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger
[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow
[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client
[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id
[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id
[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution
[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History
[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions
[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library
[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions
[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators
[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers
[**list-workflows**](#list-workflows) | **GET** `/workflows` | List Workflows
[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow
[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow
[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id
[**create-external-execute-workflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger
[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create workflow
[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client
[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id
[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id
[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution
[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history
[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions
[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library
[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions
[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators
[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers
[**list-workflows**](#list-workflows) | **GET** `/workflows` | List workflows
[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow
[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow
[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger
[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id
## cancel-workflow-execution
Cancel Workflow Execution by ID
Cancel workflow execution by id
Use this API to cancel a running workflow execution.
[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-workflow-execution)
@@ -79,7 +79,7 @@ with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID
try:
# Cancel Workflow Execution by ID
# Cancel workflow execution by id
WorkflowsApi(api_client).cancel_workflow_execution(id=id)
# Below is a request that includes all optional parameters
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-external-execute-workflow
Execute Workflow via External Trigger
Execute workflow via external trigger
This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-external-execute-workflow)
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
create_external_execute_workflow_request = '''sailpoint.v3.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
# Execute workflow via external trigger
results = WorkflowsApi(api_client).create_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -154,7 +154,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-workflow
Create Workflow
Create workflow
Create a new workflow with the desired trigger and steps specified in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow)
@@ -197,7 +197,7 @@ with ApiClient(configuration) as api_client:
create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest |
try:
# Create Workflow
# Create workflow
new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request)
results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request)
# Below is a request that includes all optional parameters
@@ -213,7 +213,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## create-workflow-external-trigger
Generate External Trigger OAuth Client
Generate external trigger oauth client
Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow-external-trigger)
@@ -255,7 +255,7 @@ with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Generate External Trigger OAuth Client
# Generate external trigger oauth client
results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id)
# Below is a request that includes all optional parameters
@@ -271,7 +271,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-workflow
Delete Workflow By Id
Delete workflow by id
Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-workflow)
@@ -312,7 +312,7 @@ with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
try:
# Delete Workflow By Id
# Delete workflow by id
WorkflowsApi(api_client).delete_workflow(id=id)
# Below is a request that includes all optional parameters
@@ -326,7 +326,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-workflow
Get Workflow By Id
Get workflow by id
Get a single workflow by id.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow)
@@ -370,7 +370,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
@@ -386,7 +386,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/v3/get-workflow-execution)
@@ -428,7 +428,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
@@ -444,7 +444,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/v3/get-workflow-execution-history)
@@ -487,7 +487,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
@@ -504,7 +504,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.
@@ -565,7 +565,7 @@ with ApiClient(configuration) as api_client:
filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
try:
# List Workflow Executions
# List workflow executions
results = WorkflowsApi(api_client).get_workflow_executions(id=id)
# Below is a request that includes all optional parameters
@@ -582,7 +582,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/v3/list-complete-workflow-library)
@@ -626,7 +626,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
@@ -643,7 +643,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/v3/list-workflow-library-actions)
@@ -689,7 +689,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
@@ -706,7 +706,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/v3/list-workflow-library-operators)
@@ -744,7 +744,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
@@ -761,7 +761,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/v3/list-workflow-library-triggers)
@@ -807,7 +807,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
@@ -824,7 +824,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/v3/list-workflows)
@@ -872,7 +872,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 Workflows
# List workflows
results = WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
@@ -889,7 +889,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/v3/patch-workflow)
@@ -934,7 +934,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
@@ -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/v3/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/v3/test-external-execute-workflow)
@@ -1095,7 +1095,7 @@ with ApiClient(configuration) as api_client:
test_external_execute_workflow_request = '''sailpoint.v3.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
:::info
Workflow must be disabled in order to use this endpoint.
@@ -1167,7 +1167,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