Update to python SDK docs: 14926960824

This commit is contained in:
developer-relations-sp
2025-05-09 10:30:37 +00:00
parent f308ff9041
commit c5ed7d487d
19 changed files with 1392 additions and 107 deletions

View File

@@ -61,6 +61,9 @@ Method | HTTP request | Description
## create-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create Account
Submits an account creation task - the API then returns the task ID.
@@ -140,6 +143,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete Account
Use this API to delete an account.
This endpoint submits an account delete task and returns the task ID.
@@ -267,6 +273,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## disable-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable Account
This API submits a task to disable the account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -333,6 +342,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## disable-account-for-identity
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable IDN Account for Identity
This API submits a task to disable IDN account for a single identity.
@@ -391,6 +403,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## disable-accounts-for-identities
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable IDN Accounts for Identities
This API submits tasks to disable IDN account for each identity provided in the request body.
@@ -453,6 +468,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## enable-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable Account
This API submits a task to enable account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -519,6 +537,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## enable-account-for-identity
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable IDN Account for Identity
This API submits a task to enable IDN account for a single identity.
@@ -577,6 +598,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## enable-accounts-for-identities
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable IDN Accounts for Identities
This API submits tasks to enable IDN account for each identity provided in the request body.
@@ -639,6 +663,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Details
Use this API to return the details for a single account by its ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -699,6 +726,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-account-entitlements
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Entitlements
This API returns entitlements of the account.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -766,8 +796,11 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-accounts
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Accounts List
List accounts.
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts)
@@ -835,6 +868,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account
Use this API to update an account with a PUT request.
@@ -912,6 +948,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-reload-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Reload Account
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -972,6 +1011,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## unlock-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -1040,6 +1082,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account
Use this API to update account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.