LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13590494573

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-28 14:46:13 +00:00
parent 605196fdc5
commit 72c854f333
724 changed files with 6148 additions and 7108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md
View File

@@ -182,10 +182,10 @@ $AccessProfile = @"{
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-V2024AccessProfile -V2024AccessProfile $Result
New-V2024AccessProfile -AccessProfile $Result
# Below is a request that includes all optional parameters
# New-V2024AccessProfile -V2024AccessProfile $Result
# New-V2024AccessProfile -AccessProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile"
Write-Host $_.ErrorDetails
@@ -285,10 +285,10 @@ $AccessProfileBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result
Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result
# Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk"
Write-Host $_.ErrorDetails
@@ -529,10 +529,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result
Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile"
Write-Host $_.ErrorDetails
@@ -588,10 +588,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner
Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result
Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result
# Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md
View File

@@ -91,7 +91,7 @@ try {
Approve-V2024AccessRequest -ApprovalId $ApprovalId
# Below is a request that includes all optional parameters
# Approve-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result
# Approve-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest"
Write-Host $_.ErrorDetails
@@ -140,10 +140,10 @@ $ForwardApprovalDto = @"{
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result
Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result
# Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest"
Write-Host $_.ErrorDetails
@@ -407,10 +407,10 @@ $CommentDto = @"{
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result
Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
# Below is a request that includes all optional parameters
# Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result
# Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest"
Write-Host $_.ErrorDetails

9
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md
View File

@@ -25,6 +25,9 @@ Method | HTTP request | Description
## get-access-request-identity-metrics
:::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 API to return information access metrics.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics)
@@ -35,6 +38,7 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityId | **String** | True | Manager's identity ID.
Path | RequestedObjectId | **String** | True | Requested access item's ID.
Path | Type | **String** | True | Requested access item's type.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
@@ -58,14 +62,15 @@ Code | Description | Data Type
$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID.
$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID.
$Type = "ENTITLEMENT" # String | Requested access item's type.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return access request identity metrics
try {
Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
# Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics"
Write-Host $_.ErrorDetails

24
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md
View File

@@ -82,10 +82,10 @@ $BulkApproveAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest
Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result
Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result
# Below is a request that includes all optional parameters
# Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result
# Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest"
Write-Host $_.ErrorDetails
@@ -133,10 +133,10 @@ $CancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result
Suspend-V2024AccessRequest -CancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result
# Suspend-V2024AccessRequest -CancelAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest"
Write-Host $_.ErrorDetails
@@ -184,10 +184,10 @@ $BulkCancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest
Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result
Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result
# Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk"
Write-Host $_.ErrorDetails
@@ -251,10 +251,10 @@ $CloseAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result
Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
# Below is a request that includes all optional parameters
# Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result
# Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest"
Write-Host $_.ErrorDetails
@@ -380,10 +380,10 @@ $AccessRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-V2024AccessRequest -V2024AccessRequest $Result
New-V2024AccessRequest -AccessRequest $Result
# Below is a request that includes all optional parameters
# New-V2024AccessRequest -V2024AccessRequest $Result
# New-V2024AccessRequest -AccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest"
Write-Host $_.ErrorDetails
@@ -623,10 +623,10 @@ $AccessRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result
Set-V2024AccessRequestConfig -AccessRequestConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result
# Set-V2024AccessRequestConfig -AccessRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig"
Write-Host $_.ErrorDetails

36
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md
View File

@@ -117,10 +117,10 @@ $AccountAttributesCreate = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-V2024Account -V2024AccountAttributesCreate $Result
New-V2024Account -AccountAttributesCreate $Result
# Below is a request that includes all optional parameters
# New-V2024Account -V2024AccountAttributesCreate $Result
# New-V2024Account -AccountAttributesCreate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account"
Write-Host $_.ErrorDetails
@@ -274,10 +274,10 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
Disable-V2024Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
# Disable-V2024Account -Id $Id -AccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account"
Write-Host $_.ErrorDetails
@@ -378,10 +378,10 @@ $IdentitiesAccountsBulkRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
# Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities"
Write-Host $_.ErrorDetails
@@ -430,10 +430,10 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
Enable-V2024Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
# Enable-V2024Account -Id $Id -AccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account"
Write-Host $_.ErrorDetails
@@ -534,10 +534,10 @@ $IdentitiesAccountsBulkRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
# Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities"
Write-Host $_.ErrorDetails
@@ -655,8 +655,8 @@ Param Type | Name | Data Type | Required | Description
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
Query | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt*
Query | Sorters | **String** | (optional) | 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**
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull*
Query | Sorters | **String** | (optional) | 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, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
### Return type
[**Account[]**](../models/account)
@@ -681,8 +681,8 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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)
$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional)
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional)
$Sorters = "id,name" # String | 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)
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional)
$Sorters = "id,name" # String | 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, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
# Accounts List
@@ -749,10 +749,10 @@ $AccountAttributes = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-V2024Account -Id $Id -V2024AccountAttributes $Result
Send-V2024Account -Id $Id -AccountAttributes $Result
# Below is a request that includes all optional parameters
# Send-V2024Account -Id $Id -V2024AccountAttributes $Result
# Send-V2024Account -Id $Id -AccountAttributes $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account"
Write-Host $_.ErrorDetails
@@ -849,10 +849,10 @@ $AccountUnlockRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result
Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result
# Below is a request that includes all optional parameters
# Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result
# Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md
View File

@@ -84,10 +84,10 @@ $SourceAppCreateDto = @"{
try {
$Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result
New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result
# Below is a request that includes all optional parameters
# New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result
# New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp"
Write-Host $_.ErrorDetails
@@ -702,7 +702,7 @@ try {
Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp"
Write-Host $_.ErrorDetails
@@ -761,7 +761,7 @@ try {
Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp"
Write-Host $_.ErrorDetails
@@ -825,7 +825,7 @@ try {
Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $Result
# Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md
View File

@@ -175,10 +175,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md
View File

@@ -119,10 +119,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result
Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md
View File

@@ -103,10 +103,10 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
New-V2024CampaignFilter -V2024CampaignFilterDetails $Result
New-V2024CampaignFilter -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# New-V2024CampaignFilter -V2024CampaignFilterDetails $Result
# New-V2024CampaignFilter -CampaignFilterDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter"
Write-Host $_.ErrorDetails
@@ -312,10 +312,10 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result
Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result
# Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter"
Write-Host $_.ErrorDetails

34
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md
View File

@@ -158,7 +158,7 @@ try {
Complete-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024Campaign -Id $Id -V2024CampaignCompleteOptions $Result
# Complete-V2024Campaign -Id $Id -CampaignCompleteOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign"
Write-Host $_.ErrorDetails
@@ -310,10 +310,10 @@ $Campaign = @"{
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-V2024Campaign -V2024Campaign $Result
New-V2024Campaign -Campaign $Result
# Below is a request that includes all optional parameters
# New-V2024Campaign -V2024Campaign $Result
# New-V2024Campaign -Campaign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign"
Write-Host $_.ErrorDetails
@@ -480,10 +480,10 @@ $CampaignTemplate = @"{
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-V2024CampaignTemplate -V2024CampaignTemplate $Result
New-V2024CampaignTemplate -CampaignTemplate $Result
# Below is a request that includes all optional parameters
# New-V2024CampaignTemplate -V2024CampaignTemplate $Result
# New-V2024CampaignTemplate -CampaignTemplate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate"
Write-Host $_.ErrorDetails
@@ -624,10 +624,10 @@ $CampaignsDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result
Remove-V2024Campaigns -CampaignsDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result
# Remove-V2024Campaigns -CampaignsDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns"
Write-Host $_.ErrorDetails
@@ -1027,10 +1027,10 @@ $AdminReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move-V2024 -Id $Id -V2024AdminReviewReassign $Result
Move-V2024 -Id $Id -AdminReviewReassign $Result
# Below is a request that includes all optional parameters
# Move-V2024 -Id $Id -V2024AdminReviewReassign $Result
# Move-V2024 -Id $Id -AdminReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024"
Write-Host $_.ErrorDetails
@@ -1082,10 +1082,10 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result
Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate"
Write-Host $_.ErrorDetails
@@ -1131,10 +1131,10 @@ $CampaignReportsConfig = @"{
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result
Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result
# Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig"
Write-Host $_.ErrorDetails
@@ -1202,7 +1202,7 @@ try {
Set-V2024CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Set-V2024CampaignTemplateSchedule -Id $Id -V2024Schedule $Result
# Set-V2024CampaignTemplateSchedule -Id $Id -Schedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule"
Write-Host $_.ErrorDetails
@@ -1253,7 +1253,7 @@ try {
Start-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024Campaign -Id $Id -V2024ActivateCampaignOptions $Result
# Start-V2024Campaign -Id $Id -ActivateCampaignOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign"
Write-Host $_.ErrorDetails
@@ -1457,10 +1457,10 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result
Update-V2024Campaign -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024Campaign -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md
View File

@@ -478,10 +478,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa
try {
$Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision
Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result
Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result
# Below is a request that includes all optional parameters
# Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result
# Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision"
Write-Host $_.ErrorDetails
@@ -537,10 +537,10 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result
Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result
# Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications"
Write-Host $_.ErrorDetails
@@ -647,10 +647,10 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result
Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result
# Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync"
Write-Host $_.ErrorDetails

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md
View File

@@ -83,10 +83,10 @@ $DeployRequest = @"{
try {
$Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
New-V2024Deploy -V2024DeployRequest $Result
New-V2024Deploy -DeployRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Deploy -V2024DeployRequest $Result
# New-V2024Deploy -DeployRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy"
Write-Host $_.ErrorDetails
@@ -141,10 +141,10 @@ $ObjectMappingRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
# New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping"
Write-Host $_.ErrorDetails
@@ -207,10 +207,10 @@ $ObjectMappingBulkCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
# New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
Write-Host $_.ErrorDetails
@@ -844,10 +844,10 @@ $ObjectMappingBulkPatchRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
# Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md
View File

@@ -97,10 +97,10 @@ $ConnectorRuleCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result
New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -ConnectorRuleCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result
# New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -ConnectorRuleCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule"
Write-Host $_.ErrorDetails
@@ -335,7 +335,7 @@ try {
Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $Result
# Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -ConnectorRuleUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule"
Write-Host $_.ErrorDetails
@@ -386,10 +386,10 @@ $SourceCode = @"{
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result
Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -SourceCode $Result
# Below is a request that includes all optional parameters
# Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result
# Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -SourceCode $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md
View File

@@ -88,10 +88,10 @@ $V3CreateConnectorDto = @"{
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
New-V2024CustomConnector -V3CreateConnectorDto $Result
# Below is a request that includes all optional parameters
# New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
# New-V2024CustomConnector -V3CreateConnectorDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector"
Write-Host $_.ErrorDetails
@@ -680,10 +680,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result
Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result
# Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md
View File

@@ -197,7 +197,7 @@ try {
New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
Write-Host $_.ErrorDetails
@@ -256,7 +256,7 @@ try {
New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
Write-Host $_.ErrorDetails
@@ -382,7 +382,7 @@ try {
New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
Write-Host $_.ErrorDetails
@@ -756,7 +756,7 @@ try {
Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
Write-Host $_.ErrorDetails
@@ -1148,7 +1148,7 @@ try {
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -V2024FormElementPreviewRequest $Result
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md
View File

@@ -75,10 +75,10 @@ $CustomPasswordInstruction = @"{
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result
New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result
# Below is a request that includes all optional parameters
# New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result
# New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md
View File

@@ -65,10 +65,10 @@ $DataSegment = @""@
try {
$Result = ConvertFrom-JsonToDataSegment -Json $DataSegment
New-V2024DataSegment -V2024DataSegment $Result
New-V2024DataSegment -DataSegment $Result
# Below is a request that includes all optional parameters
# New-V2024DataSegment -V2024DataSegment $Result
# New-V2024DataSegment -DataSegment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md
View File

@@ -154,10 +154,10 @@ $Dimension = @"{
try {
$Result = ConvertFrom-JsonToDimension -Json $Dimension
New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result
New-V2024Dimension -RoleId $RoleId -Dimension $Result
# Below is a request that includes all optional parameters
# New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result
# New-V2024Dimension -RoleId $RoleId -Dimension $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension"
Write-Host $_.ErrorDetails
@@ -207,10 +207,10 @@ $DimensionBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest
Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result
Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result
# Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions"
Write-Host $_.ErrorDetails
@@ -541,10 +541,10 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result
Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result
# Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md
View File

@@ -595,7 +595,7 @@ try {
Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement"
Write-Host $_.ErrorDetails
@@ -658,10 +658,10 @@ $EntitlementRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result
Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result
# Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails
@@ -777,10 +777,10 @@ $EntitlementBulkUpdateRequest = @"{
try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result
Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result
# Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md
View File

@@ -65,10 +65,10 @@ $NetworkConfiguration = @"{
try {
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result
New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result
# Below is a request that includes all optional parameters
# New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result
# New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
@@ -162,10 +162,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result
Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result
# Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails

18
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md
View File

@@ -89,10 +89,10 @@ $WorkgroupDto = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result
# Below is a request that includes all optional parameters
# New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
# New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup"
Write-Host $_.ErrorDetails
@@ -196,10 +196,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
# Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails
@@ -260,10 +260,10 @@ $WorkgroupBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
# Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk"
Write-Host $_.ErrorDetails
@@ -547,7 +547,7 @@ try {
Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup"
Write-Host $_.ErrorDetails
@@ -602,10 +602,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
# Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails

124
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md
View File

@@ -22,11 +22,9 @@ Method | HTTP request | Description
[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations
[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk
[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config
[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config
## add-access-request-recommendations-ignored-item
@@ -75,10 +73,10 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem"
Write-Host $_.ErrorDetails
@@ -132,10 +130,10 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem"
Write-Host $_.ErrorDetails
@@ -189,10 +187,10 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem"
Write-Host $_.ErrorDetails
@@ -247,10 +245,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems"
Write-Host $_.ErrorDetails
@@ -320,54 +318,6 @@ try {
```
[[Back to top]](#)
## get-access-request-recommendations-config
:::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 returns the configurations for Access Request Recommender for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Access Request Recommendations config
try {
Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
:::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.
@@ -541,61 +491,3 @@ try {
}
```
[[Back to top]](#)
## set-access-request-recommendations-config
:::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 updates the configurations for Access Request Recommender for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | AccessRequestRecommendationConfigDto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant.
### Return type
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationConfigDto = @"{
"scoreThreshold" : 0.5,
"startDateAttribute" : "startDate",
"restrictionAttribute" : "location",
"moverAttribute" : "isMover",
"joinerAttribute" : "isJoiner",
"useRestrictionAttribute" : true
}"@
# Update Access Request Recommendations config
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto
Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md
View File

@@ -72,10 +72,10 @@ $CommonAccessItemRequest = @"{
try {
$Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest
New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result
New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result
# Below is a request that includes all optional parameters
# New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result
# New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess"
Write-Host $_.ErrorDetails
@@ -184,10 +184,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus
Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result
Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result
# Below is a request that includes all optional parameters
# Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result
# Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md
View File

@@ -80,10 +80,10 @@ $RecommendationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result
Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result
# Below is a request that includes all optional parameters
# Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result
# Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations"
Write-Host $_.ErrorDetails
@@ -182,10 +182,10 @@ $RecommendationConfigDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto
Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result
Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result
# Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig"
Write-Host $_.ErrorDetails

24
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md
View File

@@ -100,7 +100,7 @@ try {
New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $Result
# New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest"
Write-Host $_.ErrorDetails
@@ -179,10 +179,10 @@ $RoleMiningSessionDto = @"{
try {
$Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto
New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result
New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result
# Below is a request that includes all optional parameters
# New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result
# New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions"
Write-Host $_.ErrorDetails
@@ -342,7 +342,7 @@ try {
Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $Result
# Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync"
Write-Host $_.ErrorDetails
@@ -1314,10 +1314,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
# Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole"
Write-Host $_.ErrorDetails
@@ -1383,10 +1383,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
# Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0"
Write-Host $_.ErrorDetails
@@ -1442,10 +1442,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession"
Write-Host $_.ErrorDetails
@@ -1499,10 +1499,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{
try {
$Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements
Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result
Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result
# Below is a request that includes all optional parameters
# Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result
# Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md
View File

@@ -466,10 +466,10 @@ $SendAccountVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest
Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result
Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result
# Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken"
Write-Host $_.ErrorDetails
@@ -526,10 +526,10 @@ $InviteIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result
Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result
# Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite"
Write-Host $_.ErrorDetails
@@ -587,10 +587,10 @@ $ProcessIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest
Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result
Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result
# Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md
View File

@@ -87,10 +87,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
# New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
@@ -192,10 +192,10 @@ $IdentityAttributeNames = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
# Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk"
Write-Host $_.ErrorDetails
@@ -374,10 +374,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
# Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute"
Write-Host $_.ErrorDetails

84
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md
View File

@@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile
[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile
[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config
[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile
[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List
[**Show-V2024IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
## create-identity-profile
Creates an identity profile.
This creates an Identity Profile.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile)
@@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
201 | Created identity profile. | IdentityProfile
201 | The created Identity Profile | IdentityProfile
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -119,14 +119,14 @@ $IdentityProfile = @"{
"id" : "id12345"
}"@
# Create Identity Profile
# Create an Identity Profile
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-V2024IdentityProfile -V2024IdentityProfile $Result
New-V2024IdentityProfile -IdentityProfile $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityProfile -V2024IdentityProfile $Result
# New-V2024IdentityProfile -IdentityProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile"
Write-Host $_.ErrorDetails
@@ -135,15 +135,19 @@ try {
[[Back to top]](#)
## delete-identity-profile
Delete an identity profile by ID.
This deletes an Identity Profile based on ID.
On success, this endpoint will return a reference to the bulk delete task result.
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityProfileId | **String** | True | Identity profile ID.
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
### Return type
[**TaskResultSimplified**](../models/task-result-simplified)
@@ -165,9 +169,9 @@ Code | Description | Data Type
### Example
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID.
# Delete Identity Profile
# Delete an Identity Profile
try {
Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -333,14 +337,14 @@ try {
[[Back to top]](#)
## get-identity-profile
Get a single identity profile by ID.
This returns a single Identity Profile based on ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityProfileId | **String** | True | Identity profile ID.
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
### Return type
[**IdentityProfile**](../models/identity-profile)
@@ -348,7 +352,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID.
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Identity profile object. | IdentityProfile
200 | An Identity Profile object. | IdentityProfile
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -362,9 +366,9 @@ Code | Description | Data Type
### Example
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
# Get Identity Profile
# Get single Identity Profile
try {
Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -475,10 +479,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result
Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result
# Below is a request that includes all optional parameters
# Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result
# Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles"
Write-Host $_.ErrorDetails
@@ -487,7 +491,7 @@ try {
[[Back to top]](#)
## list-identity-profiles
Get a list of identity profiles, based on the specified query parameters.
This returns a list of Identity Profiles based on the specified query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles)
@@ -497,7 +501,7 @@ Param Type | Name | Data Type | Required | Description
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne*
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne*
Query | Sorters | **String** | (optional) | 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, priority, created, modified, owner.id, owner.name**
### Return type
@@ -506,7 +510,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of identity profiles. | IdentityProfile[]
200 | List of identityProfiles. | IdentityProfile[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -522,10 +526,10 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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)
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional)
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
$Sorters = "id,name" # String | 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, priority, created, modified, owner.id, owner.name** (optional)
# List Identity Profiles
# Identity Profiles List
try {
Get-V2024IdentityProfiles
@@ -601,10 +605,10 @@ $IdentityPreviewRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result
Show-V2024IdentityPreview -IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result
# Show-V2024IdentityPreview -IdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview"
Write-Host $_.ErrorDetails
@@ -663,23 +667,25 @@ try {
[[Back to top]](#)
## update-identity-profile
Update a specified identity profile with this PATCH request.
This updates the specified Identity Profile.
You cannot update these fields:
Some fields of the Schema cannot be updated. These fields are listed below:
* id
* name
* created
* modified
* identityCount
* identityRefreshRequired
* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time.
* Authoritative Source and Identity Attribute Configuration cannot be modified at once.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityProfileId | **String** | True | Identity profile ID.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Path | IdentityProfileId | **String** | True | The Identity Profile ID
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**IdentityProfile**](../models/identity-profile)
@@ -687,7 +693,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID.
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Updated identity profile. | IdentityProfile
200 | The updated Identity Profile. | IdentityProfile
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -701,22 +707,22 @@ Code | Description | Data Type
### Example
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update Identity Profile
# Update the Identity Profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result
Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result
# Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md
View File

@@ -124,10 +124,10 @@ $LifecycleState = @"{
try {
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result
New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
# Below is a request that includes all optional parameters
# New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result
# New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState"
Write-Host $_.ErrorDetails
@@ -322,10 +322,10 @@ $SetLifecycleStateRequest = @""@
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result
Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result
# Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState"
Write-Host $_.ErrorDetails
@@ -378,10 +378,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result
Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result
# Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md
View File

@@ -202,10 +202,10 @@ $MfaDuoConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
Set-V2024MFADuoConfig -MfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
# Set-V2024MFADuoConfig -MfaDuoConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig"
Write-Host $_.ErrorDetails
@@ -252,10 +252,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
# Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig"
Write-Host $_.ErrorDetails
@@ -304,10 +304,10 @@ $MfaOktaConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
Set-V2024MFAOktaConfig -MfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
# Set-V2024MFAOktaConfig -MfaOktaConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig"
Write-Host $_.ErrorDetails

190
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md
View File

@@ -1,190 +0,0 @@
---
id: v2024-machine-accounts
title: MachineAccounts
pagination_label: MachineAccounts
sidebar_label: MachineAccounts
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccounts', 'V2024MachineAccounts']
slug: /tools/sdk/powershell/v2024/methods/machine-accounts
tags: ['SDK', 'Software Development Kit', 'MachineAccounts', 'V2024MachineAccounts']
---
# MachineAccounts
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details
[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List
[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account
## get-machine-account
:::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 API to return the details for a single machine account by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Machine Account ID.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**MachineAccount**](../models/machine-account)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Machine Account object. | MachineAccount
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Machine Account Details
try {
Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-machine-accounts
:::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 returns a list of machine accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *eq, in*
Query | Sorters | **String** | (optional) | 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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type**
### Return type
[**MachineAccount[]**](../models/machine-account)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of machine account objects | MachineAccount[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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)
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *eq, in* (optional)
$Sorters = "id,name" # String | 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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional)
# Machine Accounts List
try {
Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-machine-account
:::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 API to update machine accounts details.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Machine Account ID.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**MachineAccount**](../models/machine-account)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Updated Machine Account object. | MachineAccount
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update a Machine Account
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

298
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md
View File

@@ -1,298 +0,0 @@
---
id: v2024-machine-identities
title: MachineIdentities
pagination_label: MachineIdentities
sidebar_label: MachineIdentities
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentities', 'V2024MachineIdentities']
slug: /tools/sdk/powershell/v2024/methods/machine-identities
tags: ['SDK', 'Software Development Kit', 'MachineIdentities', 'V2024MachineIdentities']
---
# MachineIdentities
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities
[**Remove-V2024MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity
[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details
[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities
[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity
## create-machine-identity
Use this API to create a machine identity.
The maximum supported length for the description field is 2000 characters.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | MachineIdentity | [**MachineIdentity**](../models/machine-identity) | True |
### Return type
[**MachineIdentity**](../models/machine-identity)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Machine Identity created. | MachineIdentity
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$MachineIdentity = @"{
"created" : "2015-05-28T14:07:17Z",
"businessApplication" : "ADService",
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"description" : "",
"attributes" : "{\"Region\":\"EU\"}",
"id" : "id12345",
"manuallyEdited" : true
}"@
# Create Machine Identities
try {
$Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity
New-V2024MachineIdentity -V2024MachineIdentity $Result
# Below is a request that includes all optional parameters
# New-V2024MachineIdentity -V2024MachineIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-machine-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.
:::
The API returns successful response if the requested machine identity was deleted.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Machine Identity ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete machine identity
try {
Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-machine-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 returns a single machine identity using the Machine Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Machine Identity ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**MachineIdentity**](../models/machine-identity)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | A machine identity object | MachineIdentity
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Machine Identity Details
try {
Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-machine-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 returns a list of machine identities.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Sorters | **String** | (optional) | 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: **businessApplication, name**
Query | Count | **Boolean** | (optional) (default to $false) | 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.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**MachineIdentity[]**](../models/machine-identity)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of machine identities. | MachineIdentity[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Sorters = "businessApplication" # String | 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: **businessApplication, name** (optional)
$Count = $true # Boolean | 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)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# List Machine Identities
try {
Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-machine-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.
:::
Use this API to update machine identity details.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Machine Identity ID.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**MachineIdentity**](../models/machine-identity)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Updated Machine Identity object. | MachineIdentity
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update a Machine Identity
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md
View File

@@ -68,10 +68,10 @@ $ManagedClientRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
New-V2024ManagedClient -V2024ManagedClientRequest $Result
New-V2024ManagedClient -ManagedClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedClient -V2024ManagedClientRequest $Result
# New-V2024ManagedClient -ManagedClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient"
Write-Host $_.ErrorDetails
@@ -312,10 +312,10 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result
Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md
View File

@@ -72,10 +72,10 @@ $ManagedClusterRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
New-V2024ManagedCluster -ManagedClusterRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
# New-V2024ManagedCluster -ManagedClusterRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster"
Write-Host $_.ErrorDetails
@@ -312,10 +312,10 @@ $PutClientLogConfigurationRequest = @""@
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result
Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result
# Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration"
Write-Host $_.ErrorDetails
@@ -366,10 +366,10 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result
Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster"
Write-Host $_.ErrorDetails

66
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md
View File

@@ -121,10 +121,10 @@ $NonEmployeeApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result
Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result
# Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest"
Write-Host $_.ErrorDetails
@@ -181,10 +181,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result
New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result
# New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord"
Write-Host $_.ErrorDetails
@@ -240,10 +240,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result
New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result
# New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest"
Write-Host $_.ErrorDetails
@@ -252,7 +252,7 @@ try {
[[Back to top]](#)
## create-non-employee-source
Create a non-employee source.
This request will create a non-employee source. Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source)
@@ -311,10 +311,10 @@ $NonEmployeeSourceRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result
New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result
# New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource"
Write-Host $_.ErrorDetails
@@ -367,10 +367,10 @@ $NonEmployeeSchemaAttributeBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result
New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result
# New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
@@ -459,10 +459,10 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result
Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result
# Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk"
Write-Host $_.ErrorDetails
@@ -1404,20 +1404,22 @@ try {
[[Back to top]](#)
## list-non-employee-sources
Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter:
1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`.
2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns.
This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request a list sources assigned to a particular account manager by passing in that manager's id.
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user.
Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source.
Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source.
Query | Sorters | **String** | (optional) | 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: **name, created, sourceId**
### Return type
@@ -1439,20 +1441,20 @@ Code | Description | Data Type
### Example
```powershell
$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user.
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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)
$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional)
$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false)
$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional)
$Sorters = "name,created" # String | 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: **name, created, sourceId** (optional)
# List Non-Employee Sources
try {
Get-V2024NonEmployeeSources
Get-V2024NonEmployeeSources -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters
# Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources"
Write-Host $_.ErrorDetails
@@ -1507,10 +1509,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result
Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord"
Write-Host $_.ErrorDetails
@@ -1565,10 +1567,10 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result
Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result
# Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
@@ -1618,10 +1620,10 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result
Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result
# Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource"
Write-Host $_.ErrorDetails
@@ -1668,10 +1670,10 @@ $NonEmployeeRejectApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result
Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result
# Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest"
Write-Host $_.ErrorDetails
@@ -1734,10 +1736,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result
Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result
# Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord"
Write-Host $_.ErrorDetails

24
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md
View File

@@ -77,10 +77,10 @@ $DomainAddress = @"{
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result
# Below is a request that includes all optional parameters
# New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
# New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim"
Write-Host $_.ErrorDetails
@@ -147,10 +147,10 @@ $TemplateDto = @"{
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result
# Below is a request that includes all optional parameters
# New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
# New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate"
Write-Host $_.ErrorDetails
@@ -203,10 +203,10 @@ $EmailStatusDto = @"{
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result
# Below is a request that includes all optional parameters
# New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
# New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress"
Write-Host $_.ErrorDetails
@@ -259,10 +259,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result
# Below is a request that includes all optional parameters
# Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
# Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk"
Write-Host $_.ErrorDetails
@@ -775,10 +775,10 @@ $MailFromAttributesDto = @"{
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result
# Below is a request that includes all optional parameters
# Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
# Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes"
Write-Host $_.ErrorDetails
@@ -831,10 +831,10 @@ $SendTestNotificationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result
# Below is a request that includes all optional parameters
# Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
# Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md
View File

@@ -78,10 +78,10 @@ $CreateOAuthClientRequest = @"{
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
New-V2024OauthClient -CreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
# New-V2024OauthClient -CreateOAuthClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient"
Write-Host $_.ErrorDetails
@@ -269,10 +269,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result
Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md
View File

@@ -173,10 +173,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md
View File

@@ -70,10 +70,10 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
New-V2024PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
# New-V2024PasswordOrgConfig -PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig"
Write-Host $_.ErrorDetails
@@ -166,10 +166,10 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
# Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md
View File

@@ -91,10 +91,10 @@ $PasswordDigitTokenReset = @"{
try {
$Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset
New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result
New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result
# Below is a request that includes all optional parameters
# New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result
# New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken"
Write-Host $_.ErrorDetails
@@ -187,10 +187,10 @@ $PasswordInfoQueryDTO = @"{
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result
Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result
# Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo"
Write-Host $_.ErrorDetails
@@ -258,10 +258,10 @@ $PasswordChangeRequest = @"{
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-V2024Password -V2024PasswordChangeRequest $Result
Set-V2024Password -PasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024Password -V2024PasswordChangeRequest $Result
# Set-V2024Password -PasswordChangeRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md
View File

@@ -100,10 +100,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result
New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result
# New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy"
Write-Host $_.ErrorDetails
@@ -323,10 +323,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result
Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result
# Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md
View File

@@ -98,10 +98,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
New-V2024PasswordSyncGroup -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
# New-V2024PasswordSyncGroup -PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails
@@ -294,10 +294,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result
Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result
# Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md
View File

@@ -73,10 +73,10 @@ $CreatePersonalAccessTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result
New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
# Below is a request that includes all optional parameters
# New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result
# New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken"
Write-Host $_.ErrorDetails
@@ -221,10 +221,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result
Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md
View File

@@ -123,10 +123,10 @@ $PublicIdentityConfig = @"{
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result
Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result
# Below is a request that includes all optional parameters
# Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result
# Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md
View File

@@ -211,10 +211,10 @@ $ReportDetails = @"{
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
Start-V2024Report -V2024ReportDetails $Result
Start-V2024Report -ReportDetails $Result
# Below is a request that includes all optional parameters
# Start-V2024Report -V2024ReportDetails $Result
# Start-V2024Report -ReportDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report"
Write-Host $_.ErrorDetails

26
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md
View File

@@ -267,10 +267,10 @@ $Role = @"{
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-V2024Role -V2024Role $Result
New-V2024Role -Role $Result
# Below is a request that includes all optional parameters
# New-V2024Role -V2024Role $Result
# New-V2024Role -Role $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role"
Write-Host $_.ErrorDetails
@@ -318,10 +318,10 @@ $RoleBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result
Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result
# Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles"
Write-Host $_.ErrorDetails
@@ -796,10 +796,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result
Update-V2024Role -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024Role -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role"
Write-Host $_.ErrorDetails
@@ -865,7 +865,7 @@ try {
Search-V2024RolesByFilter
# Below is a request that includes all optional parameters
# Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $Result
# Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter"
Write-Host $_.ErrorDetails
@@ -968,10 +968,10 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest
Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result
Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result
# Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter"
Write-Host $_.ErrorDetails
@@ -1025,10 +1025,10 @@ $RoleMetadataBulkUpdateByIdRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest
Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result
Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result
# Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds"
Write-Host $_.ErrorDetails
@@ -1097,10 +1097,10 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest
Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result
Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result
# Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery"
Write-Host $_.ErrorDetails

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md
View File

@@ -91,10 +91,10 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
# New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration"
Write-Host $_.ErrorDetails
@@ -296,10 +296,10 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
# Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule"
Write-Host $_.ErrorDetails
@@ -350,10 +350,10 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
# Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes"
Write-Host $_.ErrorDetails
@@ -421,10 +421,10 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
# Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration"
Write-Host $_.ErrorDetails

18
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md
View File

@@ -153,10 +153,10 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-V2024SodPolicy -V2024SodPolicy $Result
New-V2024SodPolicy -SodPolicy $Result
# Below is a request that includes all optional parameters
# New-V2024SodPolicy -V2024SodPolicy $Result
# New-V2024SodPolicy -SodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy"
Write-Host $_.ErrorDetails
@@ -679,10 +679,10 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result
Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy"
Write-Host $_.ErrorDetails
@@ -812,10 +812,10 @@ $SodPolicySchedule = @"{
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result
Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result
# Below is a request that includes all optional parameters
# Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result
# Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule"
Write-Host $_.ErrorDetails
@@ -917,10 +917,10 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result
Send-V2024SodPolicy -Id $Id -SodPolicy $Result
# Below is a request that includes all optional parameters
# Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result
# Send-V2024SodPolicy -Id $Id -SodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy"
Write-Host $_.ErrorDetails
@@ -1012,7 +1012,7 @@ try {
Start-V2024SodAllPoliciesForOrg
# Below is a request that includes all optional parameters
# Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result
# Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md
View File

@@ -86,10 +86,10 @@ $IdentityWithNewAccess = @"{
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result
Start-V2024PredictSodViolations -IdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result
# Start-V2024PredictSodViolations -IdentityWithNewAccess $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations"
Write-Host $_.ErrorDetails
@@ -133,10 +133,10 @@ $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, access
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result
Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result
# Below is a request that includes all optional parameters
# Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result
# Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck"
Write-Host $_.ErrorDetails

63
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md
View File

@@ -27,6 +27,9 @@ Method | HTTP request | Description
## export-sp-config
:::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 post will export objects from the tenant to a JSON configuration file.
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
@@ -35,6 +38,7 @@ For more information about the object types that currently support export functi
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export.
### Return type
@@ -57,6 +61,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$ExportPayload = @"{
"description" : "Export Job 1 Test"
}"@
@@ -65,10 +70,10 @@ $ExportPayload = @"{
try {
$Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
Export-V2024SpConfig -V2024ExportPayload $Result
Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -ExportPayload $Result
# Below is a request that includes all optional parameters
# Export-V2024SpConfig -V2024ExportPayload $Result
# Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -ExportPayload $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig"
Write-Host $_.ErrorDetails
@@ -77,6 +82,9 @@ try {
[[Back to top]](#)
## get-sp-config-export
:::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 endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
The request will need one of the following security scopes:
- sp:config:read - sp:config:manage
@@ -87,6 +95,7 @@ The request will need one of the following security scopes:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the export job whose results will be downloaded.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SpConfigExportResults**](../models/sp-config-export-results)
@@ -109,14 +118,15 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download export job result.
try {
Get-V2024SpConfigExport -Id $Id
Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigExport -Id $Id
# Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport"
Write-Host $_.ErrorDetails
@@ -125,6 +135,9 @@ try {
[[Back to top]](#)
## get-sp-config-export-status
:::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 gets the status of the export job identified by the `id` parameter.
The request will need one of the following security scopes:
- sp:config:read - sp:config:manage
@@ -135,6 +148,7 @@ The request will need one of the following security scopes:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the export job whose status will be returned.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SpConfigExportJobStatus**](../models/sp-config-export-job-status)
@@ -157,14 +171,15 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get export job status
try {
Get-V2024SpConfigExportStatus -Id $Id
Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigExportStatus -Id $Id
# Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus"
Write-Host $_.ErrorDetails
@@ -173,6 +188,9 @@ try {
[[Back to top]](#)
## get-sp-config-import
:::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 gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import.
The request will need the following security scope:
- sp:config:manage
@@ -183,6 +201,7 @@ The request will need the following security scope:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the import job whose results will be downloaded.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SpConfigImportResults**](../models/sp-config-import-results)
@@ -205,14 +224,15 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download import job result
try {
Get-V2024SpConfigImport -Id $Id
Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigImport -Id $Id
# Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport"
Write-Host $_.ErrorDetails
@@ -221,6 +241,9 @@ try {
[[Back to top]](#)
## get-sp-config-import-status
:::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 gets the status of the import job identified by the `id` parameter.
For more information about the object types that currently support import functionality,
@@ -233,6 +256,7 @@ try {
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the import job whose status will be returned.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SpConfigImportJobStatus**](../models/sp-config-import-job-status)
@@ -255,14 +279,15 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get import job status
try {
Get-V2024SpConfigImportStatus -Id $Id
Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigImportStatus -Id $Id
# Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus"
Write-Host $_.ErrorDetails
@@ -271,6 +296,9 @@ try {
[[Back to top]](#)
## import-sp-config
:::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 post will import objects from a JSON configuration file into\
\ a tenant. By default, every import will first export all existing objects supported\
\ by sp-config as a backup before the import is attempted. The backup is provided\
@@ -290,6 +318,7 @@ try {
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported.
Query | Preview | **Boolean** | (optional) (default to $false) | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
| Options | [**ImportOptions**](../models/import-options) | (optional) |
@@ -314,6 +343,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Data = # System.IO.FileInfo | JSON file containing the objects to be imported.
$Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false)
$Options = @""@
@@ -321,10 +351,10 @@ $Options = @""@
# Initiates configuration objects import job
try {
Import-V2024SpConfig -Data $Data
Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data
# Below is a request that includes all optional parameters
# Import-V2024SpConfig -Data $Data -Preview $Preview -V2024Options $Options
# Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data -Preview $Preview -Options $Options
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig"
Write-Host $_.ErrorDetails
@@ -333,6 +363,9 @@ try {
[[Back to top]](#)
## list-sp-config-objects
:::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 gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects)
@@ -340,6 +373,7 @@ This gets the list of object configurations which are known to the tenant export
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SpConfigObject[]**](../models/sp-config-object)
@@ -361,14 +395,15 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get config object details
try {
Get-V2024SpConfigObjects
Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigObjects
# Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md
View File

@@ -71,10 +71,10 @@ $CreateSavedSearchRequest = @""@
try {
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result
New-V2024SavedSearch -CreateSavedSearchRequest $Result
# Below is a request that includes all optional parameters
# New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result
# New-V2024SavedSearch -CreateSavedSearchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch"
Write-Host $_.ErrorDetails
@@ -178,10 +178,10 @@ $SearchArguments = @"{
try {
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result
Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result
# Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch"
Write-Host $_.ErrorDetails
@@ -372,10 +372,10 @@ $SavedSearch = @"{
try {
$Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result
Send-V2024SavedSearch -Id $Id -SavedSearch $Result
# Below is a request that includes all optional parameters
# Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result
# Send-V2024SavedSearch -Id $Id -SavedSearch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md
View File

@@ -88,10 +88,10 @@ $CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7b
try {
$Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest
New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result
New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result
# New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch"
Write-Host $_.ErrorDetails
@@ -284,10 +284,10 @@ $TypedReference = @"{
try {
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result
Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
# Below is a request that includes all optional parameters
# Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result
# Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch"
Write-Host $_.ErrorDetails
@@ -424,10 +424,10 @@ $ScheduledSearch = @"{
try {
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch
Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result
Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result
# Below is a request that includes all optional parameters
# Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result
# Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md
View File

@@ -203,10 +203,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-V2024Aggregate -V2024Search $Result
Search-V2024Aggregate -Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count
# Search-V2024Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate"
Write-Host $_.ErrorDetails
@@ -365,10 +365,10 @@ $Search = @"{
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-V2024Count -V2024Search $Result
Search-V2024Count -Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Count -V2024Search $Result
# Search-V2024Count -Search $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count"
Write-Host $_.ErrorDetails
@@ -581,10 +581,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-V2024Post -V2024Search $Result
Search-V2024Post -Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count
# Search-V2024Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md
View File

@@ -85,10 +85,10 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result
New-V2024SearchAttributeConfig -SearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result
# New-V2024SearchAttributeConfig -SearchAttributeConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails
@@ -277,10 +277,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result
Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result
# Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md
View File

@@ -100,10 +100,10 @@ $Segment = @"{
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-V2024Segment -V2024Segment $Result
New-V2024Segment -Segment $Result
# Below is a request that includes all optional parameters
# New-V2024Segment -V2024Segment $Result
# New-V2024Segment -Segment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment"
Write-Host $_.ErrorDetails

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md
View File

@@ -122,10 +122,10 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result
New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result
# New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration"
Write-Host $_.ErrorDetails
@@ -451,10 +451,10 @@ $PatchServiceDeskIntegrationRequest = @""@
try {
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result
Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result
# Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration"
Write-Host $_.ErrorDetails
@@ -533,10 +533,10 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result
Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result
# Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration"
Write-Host $_.ErrorDetails
@@ -583,10 +583,10 @@ $QueuedCheckConfigDetails = @"{
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result
Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result
# Below is a request that includes all optional parameters
# Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result
# Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails"
Write-Host $_.ErrorDetails

72
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md
View File

@@ -204,10 +204,10 @@ $ProvisioningPolicyDto = @"{
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result
New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result
# New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy"
Write-Host $_.ErrorDetails
@@ -334,10 +334,10 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures
try {
$Result = ConvertFrom-JsonToSource -Json $Source
New-V2024Source -V2024Source $Result
New-V2024Source -Source $Result
# Below is a request that includes all optional parameters
# New-V2024Source -V2024Source $Result -ProvisionAsCsv $ProvisionAsCsv
# New-V2024Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source"
Write-Host $_.ErrorDetails
@@ -383,10 +383,10 @@ $Schedule1 = @""@
try {
$Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1
New-V2024SourceSchedule -SourceId $SourceId -V2024Schedule1 $Result
New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result
# Below is a request that includes all optional parameters
# New-V2024SourceSchedule -SourceId $SourceId -V2024Schedule1 $Result
# New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule"
Write-Host $_.ErrorDetails
@@ -465,10 +465,10 @@ $Schema = @"{
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
New-V2024SourceSchema -SourceId $SourceId -V2024Schema $Result
New-V2024SourceSchema -SourceId $SourceId -Schema $Result
# Below is a request that includes all optional parameters
# New-V2024SourceSchema -SourceId $SourceId -V2024Schema $Result
# New-V2024SourceSchema -SourceId $SourceId -Schema $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema"
Write-Host $_.ErrorDetails
@@ -1870,10 +1870,10 @@ $ResourceObjectsRequest = @"{
try {
$Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest
Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result
Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result
# Below is a request that includes all optional parameters
# Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result
# Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects"
Write-Host $_.ErrorDetails
@@ -1990,10 +1990,10 @@ $CorrelationConfig = @"{
try {
$Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig
Send-V2024CorrelationConfig -Id $Id -V2024CorrelationConfig $Result
Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024CorrelationConfig -Id $Id -V2024CorrelationConfig $Result
# Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig"
Write-Host $_.ErrorDetails
@@ -2051,10 +2051,10 @@ $NativeChangeDetectionConfig = @"{
try {
$Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig
Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result
Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result
# Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig"
Write-Host $_.ErrorDetails
@@ -2143,10 +2143,10 @@ $ProvisioningPolicyDto = @"{
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024ProvisioningPolicyDto $Result
Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024ProvisioningPolicyDto $Result
# Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy"
Write-Host $_.ErrorDetails
@@ -2286,10 +2286,10 @@ $Source = @"{
try {
$Result = ConvertFrom-JsonToSource -Json $Source
Send-V2024Source -Id $Id -V2024Source $Result
Send-V2024Source -Id $Id -Source $Result
# Below is a request that includes all optional parameters
# Send-V2024Source -Id $Id -V2024Source $Result
# Send-V2024Source -Id $Id -Source $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source"
Write-Host $_.ErrorDetails
@@ -2358,10 +2358,10 @@ $AttrSyncSourceConfig = @"{
try {
$Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig
Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result
Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result
# Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig"
Write-Host $_.ErrorDetails
@@ -2452,10 +2452,10 @@ $Schema = @"{
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024Schema $Result
Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
# Below is a request that includes all optional parameters
# Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024Schema $Result
# Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema"
Write-Host $_.ErrorDetails
@@ -2657,10 +2657,10 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
try {
$Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner
Update-V2024PasswordPolicyHolders -SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result
Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PasswordPolicyHolders -SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result
# Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders"
Write-Host $_.ErrorDetails
@@ -2746,10 +2746,10 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result
Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result
# Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk"
Write-Host $_.ErrorDetails
@@ -2804,10 +2804,10 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result
Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result
# Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy"
Write-Host $_.ErrorDetails
@@ -2873,10 +2873,10 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result
Update-V2024Source -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024Source -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source"
Write-Host $_.ErrorDetails
@@ -2940,10 +2940,10 @@ $SourceEntitlementRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig
Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result
Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result
# Below is a request that includes all optional parameters
# Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result
# Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig"
Write-Host $_.ErrorDetails
@@ -3001,10 +3001,10 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result
Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result
# Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule"
Write-Host $_.ErrorDetails
@@ -3086,10 +3086,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result
Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result
# Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema"
Write-Host $_.ErrorDetails

80
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md
View File

@@ -30,6 +30,9 @@ Method | HTTP request | Description
## get-sed-batch-stats
:::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.
:::
'Submit Sed Batch Stats Request.
Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
@@ -42,6 +45,7 @@ Method | HTTP request | Description
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | BatchId | **String** | True | Batch Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SedBatchStats**](../models/sed-batch-stats)
@@ -64,14 +68,15 @@ Code | Description | Data Type
### Example
```powershell
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Submit Sed Batch Stats Request
try {
Get-V2024SedBatchStats -BatchId $BatchId
Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SedBatchStats -BatchId $BatchId
# Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats"
Write-Host $_.ErrorDetails
@@ -80,6 +85,9 @@ try {
[[Back to top]](#)
## get-sed-batches
:::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.
:::
List Sed Batches.
API responses with Sed Batch Status
@@ -88,6 +96,7 @@ API responses with Sed Batch Status
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SedBatchStatus**](../models/sed-batch-status)
@@ -109,14 +118,15 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Sed Batch Request
try {
Get-V2024SedBatches
Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SedBatches
# Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches"
Write-Host $_.ErrorDetails
@@ -125,6 +135,9 @@ try {
[[Back to top]](#)
## list-seds
:::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.
:::
List of Suggested Entitlement Descriptions (SED)
SED field descriptions:
@@ -146,14 +159,14 @@ SED field descriptions:
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co*
Query | Sorters | **String** | (optional) | 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: **displayName, sourceName, status**
Query | CountOnly | **Boolean** | (optional) (default to $false) | 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
Query | RequestedByAnyone | **Boolean** | (optional) (default to $false) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
Query | ShowPendingStatusOnly | **Boolean** | (optional) (default to $false) | Will limit records to items that are in ""suggested"" or ""approved"" status
Query | Count | **Boolean** | (optional) | 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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.
Query | CountOnly | **Boolean** | (optional) | 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array.
Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status
### Return type
[**Sed[]**](../models/sed)
@@ -175,22 +188,22 @@ Code | Description | Data Type
### Example
```powershell
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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)
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
$Filters = 'displayName co "Read and Write"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
$Sorters = "sorters=displayName" # String | 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: **displayName, sourceName, status** (optional)
$CountOnly = $false # Boolean | 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)
$Count = $false # Boolean | 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional)
$CountOnly = $false # Boolean | 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional)
$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional)
# List Suggested Entitlement Descriptions
try {
Get-V2024Seds
Get-V2024Seds -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
# Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds"
Write-Host $_.ErrorDetails
@@ -246,10 +259,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result
Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result
# Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed"
Write-Host $_.ErrorDetails
@@ -258,6 +271,9 @@ try {
[[Back to top]](#)
## submit-sed-approval
:::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.
:::
Submit Bulk Approval Request for SED.
Request body takes list of SED Ids. API responses with list of SED Approval Status
@@ -266,6 +282,7 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval
### Return type
@@ -288,6 +305,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedApproval = @"{
"items" : "016629d1-1d25-463f-97f3-c6686846650"
}"@ # SedApproval[] | Sed Approval
@@ -297,10 +315,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-V2024SedApproval -V2024SedApproval $Result
Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result
# Below is a request that includes all optional parameters
# Submit-V2024SedApproval -V2024SedApproval $Result
# Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval"
Write-Host $_.ErrorDetails
@@ -309,6 +327,9 @@ try {
[[Back to top]](#)
## submit-sed-assignment
:::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.
:::
Submit Assignment Request.
Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together
@@ -317,6 +338,7 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request
### Return type
@@ -339,6 +361,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedAssignment = @"{
"assignee" : {
"type" : "SOURCE_OWNER",
@@ -351,10 +374,10 @@ $SedAssignment = @"{
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-V2024SedAssignment -V2024SedAssignment $Result
Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result
# Below is a request that includes all optional parameters
# Submit-V2024SedAssignment -V2024SedAssignment $Result
# Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment"
Write-Host $_.ErrorDetails
@@ -363,6 +386,9 @@ try {
[[Back to top]](#)
## submit-sed-batch-request
:::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.
:::
Submit Sed Batch Request.
Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together
@@ -371,6 +397,7 @@ Request body has one of the following: - a list of entitlement Ids - a list of S
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request
### Return type
@@ -393,6 +420,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedBatchRequest = @"{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
@@ -401,10 +429,10 @@ $SedBatchRequest = @"{
# Submit Sed Batch Request
try {
Submit-V2024SedBatchRequest
Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Submit-V2024SedBatchRequest -V2024SedBatchRequest $Result
# Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -SedBatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest"
Write-Host $_.ErrorDetails

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md
View File

@@ -173,10 +173,10 @@ $BulkRemoveTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result
Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result
# Below is a request that includes all optional parameters
# Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result
# Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject"
Write-Host $_.ErrorDetails
@@ -385,10 +385,10 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result
Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result
# Below is a request that includes all optional parameters
# Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result
# Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject"
Write-Host $_.ErrorDetails
@@ -440,10 +440,10 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-V2024TagToObject -V2024TaggedObject $Result
Set-V2024TagToObject -TaggedObject $Result
# Below is a request that includes all optional parameters
# Set-V2024TagToObject -V2024TaggedObject $Result
# Set-V2024TagToObject -TaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject"
Write-Host $_.ErrorDetails
@@ -498,10 +498,10 @@ $BulkAddTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject
Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result
Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result
# Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md
View File

@@ -293,10 +293,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus"
Write-Host $_.ErrorDetails

9
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md
View File

@@ -21,6 +21,9 @@ Method | HTTP request | Description
## get-tenant
:::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 rest endpoint can be used to retrieve tenant details.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant)
@@ -28,6 +31,7 @@ This rest endpoint can be used to retrieve tenant details.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**Tenant**](../models/tenant)
@@ -49,14 +53,15 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Tenant Information.
try {
Get-V2024Tenant
Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Tenant
# Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant"
Write-Host $_.ErrorDetails

6
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md
View File

@@ -86,10 +86,10 @@ $Transform = @"{
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-V2024Transform -V2024Transform $Result
New-V2024Transform -Transform $Result
# Below is a request that includes all optional parameters
# New-V2024Transform -V2024Transform $Result
# New-V2024Transform -Transform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform"
Write-Host $_.ErrorDetails
@@ -303,7 +303,7 @@ try {
Update-V2024Transform -Id $Id
# Below is a request that includes all optional parameters
# Update-V2024Transform -Id $Id -V2024Transform $Result
# Update-V2024Transform -Id $Id -Transform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform"
Write-Host $_.ErrorDetails

24
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md
View File

@@ -118,10 +118,10 @@ $CompleteInvocation = @"{
try {
$Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result
Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result
# Below is a request that includes all optional parameters
# Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result
# Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation"
Write-Host $_.ErrorDetails
@@ -195,10 +195,10 @@ $SubscriptionPostRequest = @"{
try {
$Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result
New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result
# New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription"
Write-Host $_.ErrorDetails
@@ -479,10 +479,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result
Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription"
Write-Host $_.ErrorDetails
@@ -540,10 +540,10 @@ $TestInvocation = @"{
try {
$Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result
Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result
# Below is a request that includes all optional parameters
# Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result
# Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation"
Write-Host $_.ErrorDetails
@@ -597,10 +597,10 @@ $ValidateFilterInputDto = @"{
try {
$Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result
Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result
# Below is a request that includes all optional parameters
# Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result
# Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter"
Write-Host $_.ErrorDetails
@@ -683,10 +683,10 @@ $SubscriptionPutRequest = @"{
try {
$Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest
Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result
Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md
View File

@@ -116,10 +116,10 @@ $TenantUiMetadataItemUpdateRequest = @"{
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest
Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result
Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result
# Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md
View File

@@ -85,10 +85,10 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
New-V2024VendorConnectorMapping -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
# New-V2024VendorConnectorMapping -VendorConnectorMapping $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping"
Write-Host $_.ErrorDetails
@@ -155,10 +155,10 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
# Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md
View File

@@ -603,10 +603,10 @@ $WorkItemForward = @"{
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result
Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result
# Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md
View File

@@ -84,10 +84,10 @@ $ConfigurationItemRequest = @"{
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
# New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration"
Write-Host $_.ErrorDetails
@@ -448,10 +448,10 @@ $ConfigurationItemRequest = @"{
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
# Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig"
Write-Host $_.ErrorDetails
@@ -503,10 +503,10 @@ $TenantConfigurationRequest = @"{
try {
$Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest
Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result
Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result
# Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration"
Write-Host $_.ErrorDetails

20
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md
View File

@@ -123,7 +123,7 @@ try {
New-V2024ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result
# New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow"
Write-Host $_.ErrorDetails
@@ -166,10 +166,10 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
New-V2024Workflow -V2024CreateWorkflowRequest $Result
New-V2024Workflow -CreateWorkflowRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Workflow -V2024CreateWorkflowRequest $Result
# New-V2024Workflow -CreateWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow"
Write-Host $_.ErrorDetails
@@ -741,10 +741,10 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result
Update-V2024Workflow -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result
# Update-V2024Workflow -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow"
Write-Host $_.ErrorDetails
@@ -827,10 +827,10 @@ $WorkflowBody = @"{
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result
Send-V2024Workflow -Id $Id -WorkflowBody $Result
# Below is a request that includes all optional parameters
# Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result
# Send-V2024Workflow -Id $Id -WorkflowBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow"
Write-Host $_.ErrorDetails
@@ -877,7 +877,7 @@ try {
Test-V2024ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result
# Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow"
Write-Host $_.ErrorDetails
@@ -924,10 +924,10 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b,
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest
Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result
Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result
# Below is a request that includes all optional parameters
# Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result
# Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow"
Write-Host $_.ErrorDetails

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessCriteria.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessCriteria = Initialize-PSSailpoint.V2024AccessCriteria -Name money-in `
-CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}]
-CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}]
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileEntitlement.md
View File

@@ -39,7 +39,7 @@ $AccessProfileEntitlement = Initialize-PSSailpoint.V2024AccessProfileEntitlement
-Type ENTITLEMENT `
-Privileged false `
-Attribute memberOf `
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
-Standalone false
```

4
docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileUpdateItem.md
View File

@@ -29,9 +29,9 @@ $AccessProfileUpdateItem = Initialize-PSSailpoint.V2024AccessProfileUpdateItem
-Requestable false `
-Status 201 `
-Description
> Access profile is updated successfully.
> Access profile is updated successfully.
> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found.
> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found.
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md
View File

@@ -28,7 +28,7 @@ Name | Type | Description | Notes
$AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor null `
-RequestType null `
-RequestedItems null `
-ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}
-ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatus.md
View File

@@ -68,7 +68,7 @@ $AccessRequestAdminItemStatus = Initialize-PSSailpoint.V2024AccessRequestAdminIt
-Cancelable true `
-ReauthorizationRequired true `
-AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 `
-ClientMetadata {key1=value1, key2=value2}
-ClientMetadata {key1=value1, key2=value2}
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md
View File

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
$AccessRequestItem = Initialize-PSSailpoint.V2024AccessRequestItem -Type ACCESS_PROFILE `
-Id 2c9180835d2e5168015d32f890ca1581 `
-Comment Requesting access profile for John Doe `
-ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} `
-ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} `
-RemoveDate 2020-07-11T21:23:15Z
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md
View File

@@ -36,7 +36,7 @@ $AccessRequestItemResponse = Initialize-PSSailpoint.V2024AccessRequestItemRespon
-Description The role descrition `
-SourceId 8a80828f643d484f01643e14202e206f `
-SourceName Source1 `
-ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]
-ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md
View File

@@ -35,7 +35,7 @@ $AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.V20
-Type ACCESS_PROFILE `
-Operation Add `
-Comment William needs this access to do his job. `
-ClientMetadata {applicationName=My application} `
-ClientMetadata {applicationName=My application} `
-ApprovalInfo null
```

45
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md
View File

@@ -1,45 +0,0 @@
---
id: v2024-access-request-recommendation-config-dto
title: AccessRequestRecommendationConfigDto
pagination_label: AccessRequestRecommendationConfigDto
sidebar_label: AccessRequestRecommendationConfigDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-config-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
---
# AccessRequestRecommendationConfigDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ScoreThreshold** | **Double** | The value that internal calculations need to exceed for recommendations to be made. | [required]
**StartDateAttribute** | **String** | Use to map an attribute name for determining identities' start date. | [optional]
**RestrictionAttribute** | **String** | Use to only give recommendations based on this attribute. | [optional]
**MoverAttribute** | **String** | Use to map an attribute name for determining whether identities are movers. | [optional]
**JoinerAttribute** | **String** | Use to map an attribute name for determining whether identities are joiners. | [optional]
**UseRestrictionAttribute** | **Boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationConfigDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationConfigDto -ScoreThreshold 0.5 `
-StartDateAttribute startDate `
-RestrictionAttribute location `
-MoverAttribute isMover `
-JoinerAttribute isJoiner `
-UseRestrictionAttribute true
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationConfigDto | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md
View File

@@ -34,7 +34,7 @@ $AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.V2024AccessReque
-Requested true `
-Viewed true `
-Messages null `
-TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}]
-TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}]
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse.md
View File

@@ -23,8 +23,8 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessRequestResponse = Initialize-PSSailpoint.V2024AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] `
-ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}]
$AccessRequestResponse = Initialize-PSSailpoint.V2024AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] `
-ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}]
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
```powershell
$AccessRequestResponse1 = Initialize-PSSailpoint.V2024AccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf `
-RequesterName Bing C `
-Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}]
-Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}]
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestTracking.md
View File

@@ -27,8 +27,8 @@ Name | Type | Description | Notes
```powershell
$AccessRequestTracking = Initialize-PSSailpoint.V2024AccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 `
-RequestedItemsDetails {
"type": "ENTITLEMENT",
"id": "779c6fd7171540bba1184e5946112c28"
"type": "ENTITLEMENT",
"id": "779c6fd7171540bba1184e5946112c28"
} `
-AttributesHash -1928438224 `
-AccessRequestIds [5d3118c518a44ec7805450d53479ccdb]

2
docs/tools/sdk/powershell/Reference/V2024/Models/Account.md
View File

@@ -61,7 +61,7 @@ $Account = Initialize-PSSailpoint.V2024Account -Id id12345 `
-ConnectionType direct `
-IsMachine true `
-Recommendation null `
-Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} `
-Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} `
-Authoritative false `
-Description null `
-Disabled false `

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivity.md
View File

@@ -48,7 +48,7 @@ $AccountActivity = Initialize-PSSailpoint.V2024AccountActivity -Id 2c9180835d2e
-Warnings [Some warning, another warning] `
-Items null `
-ExecutionStatus null `
-ClientMetadata {customKey1=custom value 1, customKey2=custom value 2}
-ClientMetadata {customKey1=custom value 1, customKey2=custom value 2}
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivityItem.md
View File

@@ -51,7 +51,7 @@ $AccountActivityItem = Initialize-PSSailpoint.V2024AccountActivityItem -Id 48c5
-NativeIdentity Sandie.Camero `
-SourceId 2c91808363ef85290164000587130c0c `
-AccountRequestInfo null `
-ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} `
-ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} `
-RemoveDate 2020-07-11T00:00Z
```

6
docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttribute.md
View File

@@ -35,10 +35,10 @@ $AccountAttribute = Initialize-PSSailpoint.V2024AccountAttribute -SourceName Wo
-AccountSortAttribute created `
-AccountSortDescending false `
-AccountReturnFirstLink false `
-AccountFilter !(nativeIdentity.startsWith("*DELETED*")) `
-AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') `
-AccountFilter !(nativeIdentity.startsWith("*DELETED*")) `
-AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') `
-RequiresPeriodicRefresh false `
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributes.md
View File

@@ -22,7 +22,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountAttributes = Initialize-PSSailpoint.V2024AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
$AccountAttributes = Initialize-PSSailpoint.V2024AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributesChangedAccount.md
View File

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
$AccountAttributesChangedAccount = Initialize-PSSailpoint.V2024AccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 `
-Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 `
-Name john.doe `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-Type ACCOUNT
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelated.md
View File

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
$AccountCorrelated = Initialize-PSSailpoint.V2024AccountCorrelated -Identity null `
-Source null `
-Account null `
-Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} `
-Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} `
-EntitlementCount 0
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelatedAccount.md
View File

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
$AccountCorrelatedAccount = Initialize-PSSailpoint.V2024AccountCorrelatedAccount -Type ACCOUNT `
-Id 98da47c31df444558c211f9b205184f6 `
-Name Brian Mendoza `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoDto.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountInfoDto = Initialize-PSSailpoint.V2024AccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
$AccountInfoDto = Initialize-PSSailpoint.V2024AccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
-DisplayName Abby.Smith `
-Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01}
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountUncorrelatedAccount.md
View File

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
$AccountUncorrelatedAccount = Initialize-PSSailpoint.V2024AccountUncorrelatedAccount -Type ACCOUNT `
-Id 4dd497e3723e439991cb6d0e478375dd `
-Name Sadie Jensen `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
-Count 10
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AggregationResult = Initialize-PSSailpoint.V2024AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} `
$AggregationResult = Initialize-PSSailpoint.V2024AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} `
-Hits null
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AppAccountDetailsSourceAccount.md
View File

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AppAccountDetailsSourceAccount = Initialize-PSSailpoint.V2024AppAccountDetailsSourceAccount -Id fbf4f72280304f1a8bc808fc2a3bcf7b `
-NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
-NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
-DisplayName Abby Smith `
-SourceId 10efa58ea3954883b52bf74f489ce8f9 `
-SourceDisplayName ODS-AD-SOURCE

2
docs/tools/sdk/powershell/Reference/V2024/Models/AppAllOfAccount.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AppAllOfAccount = Initialize-PSSailpoint.V2024AppAllOfAccount -Id 2c9180837dfe6949017e21f3d8cd6d49 `
-AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
-AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
```
- Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/V2024/Models/Approval.md
View File

@@ -43,17 +43,17 @@ $Approval = Initialize-PSSailpoint.V2024Approval -ApprovalId 38453251-6be2-5f8f
-CreatedDate 2023-04-12T23:20:50.52Z `
-Type ENTITLEMENT_DESCRIPTIONS `
-Name null `
-BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} `
-BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} `
-Description null `
-Priority HIGH `
-Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} `
-Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} `
-Comments null `
-ApprovedBy null `
-RejectedBy null `
-CompletedDate 2023-04-12T23:20:50.52Z `
-ApprovalCriteria SINGLE `
-Status PENDING `
-AdditionalAttributes { "llm_description": "generated description" } `
-AdditionalAttributes { "llm_description": "generated description" } `
-ReferenceData null
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AttrSyncSourceConfig.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AttrSyncSourceConfig = Initialize-PSSailpoint.V2024AttrSyncSourceConfig -Source null `
-Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}]
-Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}]
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDTOList.md
View File

@@ -22,7 +22,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AttributeDTOList = Initialize-PSSailpoint.V2024AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}]
$AttributeDTOList = Initialize-PSSailpoint.V2024AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}]
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/BackupOptions.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$BackupOptions = Initialize-PSSailpoint.V2024BackupOptions -IncludeTypes null `
-ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}
-ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}
```
- Convert the resource to JSON

2
docs/tools/sdk/powershell/Reference/V2024/Models/Base64Decode.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$Base64Decode = Initialize-PSSailpoint.V2024Base64Decode -RequiresPeriodicRefresh false `
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
```
- Convert the resource to JSON

Some files were not shown because too many files have changed in this diff Show More