Update python SDK docs: 15116515953

2025-12-09 20:37:47 +00:00 · 2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
--- a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md
+++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md
@@ -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