LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +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

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

@@ -42,29 +42,29 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-account**](#create-account) | **POST** `/accounts` | Create Account
[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account
[**delete-account-async**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account
[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account
[**disable-account-for-identity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity
[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities
[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account
[**enable-account-for-identity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity
[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities
[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account Details
[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements
[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts List
[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update Account
[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account
[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
[**create-account**](#create-account) | **POST** `/accounts` | Create account
[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account
[**delete-account-async**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove account
[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account
[**disable-account-for-identity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable idn account for identity
[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable idn accounts for identities
[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account
[**enable-account-for-identity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable idn account for identity
[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable idn accounts for identities
[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account details
[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements
[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts list
[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update account
[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account
[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account
[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update account
## create-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create Account
Create account
Submits an account creation task - the API then returns the task ID.
The `sourceId` where this account will be created must be included in the `attributes` object.
@@ -127,7 +127,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountAttributesCreate |
try:
# Create Account
# Create account
new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create)
results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create)
# Below is a request that includes all optional parameters
@@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete Account
Delete account
Use this API to delete an account.
This endpoint submits an account delete task and returns the task ID.
This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future.
@@ -193,7 +193,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Delete Account
# Delete account
results = AccountsApi(api_client).delete_account(id=id)
# Below is a request that includes all optional parameters
@@ -209,7 +209,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-account-async
Remove Account
Remove account
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
This endpoint is good for:
@@ -257,7 +257,7 @@ with ApiClient(configuration) as api_client:
id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id
try:
# Remove Account
# Remove account
results = AccountsApi(api_client).delete_account_async(id=id)
# Below is a request that includes all optional parameters
@@ -276,7 +276,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable Account
Disable account
This API submits a task to disable the account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -326,7 +326,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountToggleRequest |
try:
# Disable Account
# Disable account
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
@@ -345,7 +345,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable IDN Account for Identity
Disable idn account for identity
This API submits a task to disable IDN account for a single identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity)
@@ -387,7 +387,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
try:
# Disable IDN Account for Identity
# Disable idn account for identity
results = AccountsApi(api_client).disable_account_for_identity(id=id)
# Below is a request that includes all optional parameters
@@ -406,7 +406,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable IDN Accounts for Identities
Disable idn accounts for identities
This API submits tasks to disable IDN account for each identity provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities)
@@ -451,7 +451,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentitiesAccountsBulkRequest |
try:
# Disable IDN Accounts for Identities
# Disable idn accounts for identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).disable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
@@ -471,7 +471,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable Account
Enable account
This API submits a task to enable account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -521,7 +521,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountToggleRequest |
try:
# Enable Account
# Enable account
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
@@ -540,7 +540,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable IDN Account for Identity
Enable idn account for identity
This API submits a task to enable IDN account for a single identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity)
@@ -582,7 +582,7 @@ with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
try:
# Enable IDN Account for Identity
# Enable idn account for identity
results = AccountsApi(api_client).enable_account_for_identity(id=id)
# Below is a request that includes all optional parameters
@@ -601,7 +601,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable IDN Accounts for Identities
Enable idn accounts for identities
This API submits tasks to enable IDN account for each identity provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities)
@@ -646,7 +646,7 @@ with ApiClient(configuration) as api_client:
}''' # IdentitiesAccountsBulkRequest |
try:
# Enable IDN Accounts for Identities
# Enable idn accounts for identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).enable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
@@ -666,7 +666,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Details
Account details
Use this API to return the details for a single account by its ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -710,7 +710,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Account Details
# Account details
results = AccountsApi(api_client).get_account(id=id)
# Below is a request that includes all optional parameters
@@ -729,7 +729,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Entitlements
Account entitlements
This API returns entitlements of the account.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -779,7 +779,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# Account Entitlements
# Account entitlements
results = AccountsApi(api_client).get_account_entitlements(id=id)
# Below is a request that includes all optional parameters
@@ -799,7 +799,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Accounts List
Accounts list
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts)
@@ -851,7 +851,7 @@ with ApiClient(configuration) as api_client:
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional)
try:
# Accounts List
# Accounts list
results = AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
@@ -871,7 +871,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account
Update account
Use this API to update an account with a PUT request.
This endpoint submits an account update task and returns the task ID.
@@ -932,7 +932,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountAttributes |
try:
# Update Account
# Update account
new_account_attributes = AccountAttributes.from_json(account_attributes)
results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes)
# Below is a request that includes all optional parameters
@@ -951,7 +951,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Reload Account
Reload account
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -995,7 +995,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
try:
# Reload Account
# Reload account
results = AccountsApi(api_client).submit_reload_account(id=id)
# Below is a request that includes all optional parameters
@@ -1014,7 +1014,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Unlock Account
Unlock account
This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -1066,7 +1066,7 @@ with ApiClient(configuration) as api_client:
}''' # AccountUnlockRequest |
try:
# Unlock Account
# Unlock account
new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request)
results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request)
# Below is a request that includes all optional parameters
@@ -1085,7 +1085,7 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account
Update account
Use this API to update account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -1140,7 +1140,7 @@ with ApiClient(configuration) as api_client:
request_body = '''{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Account
# Update account
new_request_body = RequestBody.from_json(request_body)
results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters