Update PowerShell SDK docs: 16205707489

This commit is contained in:
developer-relations-sp
2025-07-10 20:50:19 +00:00
parent e451d70486
commit 63d156bb2f
12 changed files with 102 additions and 198 deletions

View File

@@ -626,7 +626,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#close-access-request
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$CloseAccessRequest = @"
{
"executionStatus" : "Terminated",
@@ -640,10 +639,10 @@
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
Close-V2024AccessRequest -CloseAccessRequest $Result
# Below is a request that includes all optional parameters
# Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
# Close-V2024AccessRequest -CloseAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest"
Write-Host $_.ErrorDetails
@@ -1094,15 +1093,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/account-aggregations#get-account-aggregation-status
source: |
$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# In-progress account aggregation status
try {
Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
Get-V2024AccountAggregationStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Get-V2024AccountAggregationStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus"
Write-Host $_.ErrorDetails
@@ -1187,15 +1185,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account-async
source: |
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Remove account
try {
Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
Remove-V2024AccountAsync -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
# Remove-V2024AccountAsync -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync"
Write-Host $_.ErrorDetails
@@ -1233,15 +1230,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account-for-identity
source: |
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Disable idn account for identity
try {
Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
Disable-V2024AccountForIdentity -Id $Id
# Below is a request that includes all optional parameters
# Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Disable-V2024AccountForIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity"
Write-Host $_.ErrorDetails
@@ -1252,7 +1248,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-accounts-for-identities
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentitiesAccountsBulkRequest = @"
{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
@@ -1263,10 +1258,10 @@
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
Disable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
# Disable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities"
Write-Host $_.ErrorDetails
@@ -1304,15 +1299,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account-for-identity
source: |
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Enable idn account for identity
try {
Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
Enable-V2024AccountForIdentity -Id $Id
# Below is a request that includes all optional parameters
# Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Enable-V2024AccountForIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity"
Write-Host $_.ErrorDetails
@@ -1323,7 +1317,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-accounts-for-identities
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentitiesAccountsBulkRequest = @"
{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
@@ -1334,10 +1327,10 @@
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
Enable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
# Enable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities"
Write-Host $_.ErrorDetails
@@ -15556,15 +15549,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-accounts-async
source: |
$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Remove all accounts in a source
# Remove all accounts in source
try {
Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
Remove-V2024AccountsAsync -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
# Remove-V2024AccountsAsync -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync"
Write-Host $_.ErrorDetails
@@ -15967,17 +15959,16 @@
label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional)
$DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional)
# Account aggregation
try {
Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental
Import-V2024Accounts -Id $Id
# Below is a request that includes all optional parameters
# Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization
# Import-V2024Accounts -Id $Id -File $File -DisableOptimization $DisableOptimization
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts"
Write-Host $_.ErrorDetails
@@ -16071,16 +16062,15 @@
label: SDK_tools/sdk/powershell/v2024/methods/sources#import-uncorrelated-accounts
source: |
$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | (optional)
# Process uncorrelated accounts
try {
Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental
Import-V2024UncorrelatedAccounts -Id $Id
# Below is a request that includes all optional parameters
# Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File
# Import-V2024UncorrelatedAccounts -Id $Id -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts"
Write-Host $_.ErrorDetails