Update to powershell SDK docs: 13207859154

2025-12-09 20:37:47 +00:00 · 2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
--- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md
+++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md
@@ -61,6 +61,7 @@ Method | HTTP request | Description
 [**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
 [**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account

+
 ## create-account
 Submit an account creation task - the API then returns the task ID.  

@@ -75,6 +76,8 @@ The endpoint doesn't actually provision the account on the target source, which
 By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.


+[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -114,22 +117,25 @@ $AccountAttributesCreate = @"{

 try {
    $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
-    New-V2024Account -V2024AccountAttributesCreate $Result
+    New-V2024Account -V2024AccountAttributesCreate $Result 
    
    # Below is a request that includes all optional parameters
-    # New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate  
+    # New-V2024Account -V2024AccountAttributesCreate $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## 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. 
 >**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.**

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -160,17 +166,21 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
 # Delete Account

 try {
-    Remove-V2024Account -V2024Id $Id 
+    Remove-V2024Account -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Remove-V2024Account -V2024Id $Id  
+    # Remove-V2024Account -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## delete-account-async
+:::warning experimental 
+This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
+:::
 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:
@@ -179,6 +189,8 @@ This endpoint is good for:
 * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.


+[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account-async)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -210,19 +222,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
 # Remove Account

 try {
-    Remove-V2024AccountAsync -V2024Id $Id  -V2024XSailPointExperimental $XSailPointExperimental 
+    Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
-    # Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
+    # Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## disable-account
 This API submits a task to disable the account and returns the task ID.      

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -259,19 +274,25 @@ $AccountToggleRequest = @"{

 try {
    $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
-    Disable-V2024Account -V2024Id $Id  -V2024AccountToggleRequest $Result
+    Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result 
    
    # Below is a request that includes all optional parameters
-    # Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest  
+    # Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## disable-account-for-identity
+:::warning experimental 
+This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
+:::
 This API submits a task to disable IDN account for a single identity.

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -304,19 +325,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
 # Disable IDN Account for Identity

 try {
-    Disable-V2024AccountForIdentity -V2024Id $Id  -V2024XSailPointExperimental $XSailPointExperimental 
+    Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
-    # Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
+    # Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## disable-accounts-for-identities
+:::warning experimental 
+This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
+:::
 This API submits tasks to disable IDN account for each identity provided in the request body.

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -351,19 +378,22 @@ $IdentitiesAccountsBulkRequest = @"{

 try {
    $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
-    Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental  -V2024IdentitiesAccountsBulkRequest $Result
+    Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result 
    
    # Below is a request that includes all optional parameters
-    # Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest  
+    # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## enable-account
 This API submits a task to enable account and returns the task ID.      

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -400,19 +430,25 @@ $AccountToggleRequest = @"{

 try {
    $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
-    Enable-V2024Account -V2024Id $Id  -V2024AccountToggleRequest $Result
+    Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result 
    
    # Below is a request that includes all optional parameters
-    # Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest  
+    # Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## enable-account-for-identity
+:::warning experimental 
+This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
+:::
 This API submits a task to enable IDN account for a single identity.

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -445,19 +481,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
 # Enable IDN Account for Identity

 try {
-    Enable-V2024AccountForIdentity -V2024Id $Id  -V2024XSailPointExperimental $XSailPointExperimental 
+    Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
-    # Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
+    # Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## enable-accounts-for-identities
+:::warning experimental 
+This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
+:::
 This API submits tasks to enable IDN account for each identity provided in the request body.

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -492,19 +534,22 @@ $IdentitiesAccountsBulkRequest = @"{

 try {
    $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
-    Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental  -V2024IdentitiesAccountsBulkRequest $Result
+    Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result 
    
    # Below is a request that includes all optional parameters
-    # Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest  
+    # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-account
 Use this API to return the details for a single account by its ID.  

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -535,19 +580,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
 # Account Details

 try {
-    Get-V2024Account -V2024Id $Id 
+    Get-V2024Account -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Get-V2024Account -V2024Id $Id  
+    # Get-V2024Account -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-account-entitlements
 This API returns entitlements of the account.      

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -584,19 +632,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
 # Account Entitlements

 try {
-    Get-V2024AccountEntitlements -V2024Id $Id 
+    Get-V2024AccountEntitlements -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count  
+    # Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## list-accounts
 List accounts. 

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -636,16 +687,17 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
 # Accounts List

 try {
-    Get-V2024Accounts
+    Get-V2024Accounts 
    
    # Below is a request that includes all optional parameters
-    # Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters  
+    # Get-V2024Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## put-account
 Use this API to update an account with a PUT request. 

@@ -654,6 +706,8 @@ This endpoint submits an account update task and returns the task ID.
 >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**


+[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -695,19 +749,22 @@ $AccountAttributes = @"{

 try {
    $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
-    Send-V2024Account -V2024Id $Id  -V2024AccountAttributes $Result
+    Send-V2024Account -Id $Id -V2024AccountAttributes $Result 
    
    # Below is a request that includes all optional parameters
-    # Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes  
+    # Send-V2024Account -Id $Id -V2024AccountAttributes $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## submit-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/v2024/submit-reload-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -738,20 +795,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
 # Reload Account

 try {
-    Submit-V2024ReloadAccount -V2024Id $Id 
+    Submit-V2024ReloadAccount -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Submit-V2024ReloadAccount -V2024Id $Id  
+    # Submit-V2024ReloadAccount -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## 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. 

+[API Spec](https://developer.sailpoint.com/docs/api/v2024/unlock-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -789,16 +849,17 @@ $AccountUnlockRequest = @"{

 try {
    $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
-    Unlock-V2024Account -V2024Id $Id  -V2024AccountUnlockRequest $Result
+    Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result 
    
    # Below is a request that includes all optional parameters
-    # Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest  
+    # Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## update-account
 Use this API to update account details. 

@@ -812,6 +873,8 @@ All accounts that are reassigned will be set to `manuallyCorrelated: true` unles
 >**Note:** The `attributes` field can only be modified for flat file accounts. 


+[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-account)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -847,10 +910,10 @@ $RequestBody =  # SystemCollectionsHashtable[] | A list of account update operat

 try {
    $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
-    Update-V2024Account -V2024Id $Id  -V2024RequestBody $Result
+    Update-V2024Account -Id $Id -RequestBody $Result 
    
    # Below is a request that includes all optional parameters
-    # Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody  
+    # Update-V2024Account -Id $Id -RequestBody $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account"
    Write-Host $_.ErrorDetails