Update PowerShell SDK docs: 16303883694

This commit is contained in:
developer-relations-sp
2025-07-15 20:43:13 +00:00
parent 7c0df548cb
commit ca8fe2cde7
31 changed files with 954 additions and 40 deletions

View File

@@ -9214,7 +9214,8 @@
{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration"
"name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}
"@
@@ -14477,7 +14478,6 @@
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID.
$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 = "status eq "Failed"" # 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List workflow executions
@@ -14486,7 +14486,7 @@
Get-BetaWorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
# Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions"
Write-Host $_.ErrorDetails

View File

@@ -11906,7 +11906,8 @@
{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration"
"name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}
"@
@@ -18618,7 +18619,6 @@
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID.
$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 = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List workflow executions
@@ -18627,7 +18627,7 @@
Get-V2024WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
# Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions"
Write-Host $_.ErrorDetails

View File

@@ -5128,6 +5128,179 @@
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions"
Write-Host $_.ErrorDetails
}
- path: /authorization/custom-user-levels
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#create-custom-user-level
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$UserLevelRequest = @"
{
"owner" : {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
"type" : "IDENTITY"
},
"rightSets" : [ "idn:ui-right-set-list-read-example", "idn:ui-right-set-write-example" ],
"name" : "Custom User Level Name",
"description" : "This is a description of the custom user level."
}
"@
# Create a custom user level
try {
$Result = ConvertFrom-JsonToUserLevelRequest -Json $UserLevelRequest
New-V2025CustomUserLevel -XSailPointExperimental $XSailPointExperimental -UserLevelRequest $Result
# Below is a request that includes all optional parameters
# New-V2025CustomUserLevel -XSailPointExperimental $XSailPointExperimental -UserLevelRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomUserLevel"
Write-Host $_.ErrorDetails
}
- path: /authorization/custom-user-levels/{id}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#delete-user-level
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Id = "6e110911-5984-491b-be74-2707980a46a7" # String | The unique identifier of the user level.
# Delete a user level
try {
Remove-V2025UserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2025UserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025UserLevel"
Write-Host $_.ErrorDetails
}
- path: /authorization/custom-user-levels/{id}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#get-user-level
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Id = "6e110911-5984-491b-be74-2707980a46a7" # String | The unique identifier of the user level.
# Retrieve a user level
try {
Get-V2025UserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id
# Below is a request that includes all optional parameters
# Get-V2025UserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UserLevel"
Write-Host $_.ErrorDetails
}
- path: /authorization/authorization-assignable-right-sets
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#list-all-authorization-right-sets
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Filters = "category eq "identity"" # 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: **category**: *eq* (optional)
$Sorters = "name, -id, -category" # 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, category** (optional)
$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 all uiAssignable right sets
try {
Get-V2025AllAuthorizationRightSets -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2025AllAuthorizationRightSets -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllAuthorizationRightSets"
Write-Host $_.ErrorDetails
}
- path: /authorization/custom-user-levels
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#list-user-levels
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$DetailLevel = "FULL" # String | Specifies the level of detail for the user levels. (optional)
$Filters = "name co "identity", owner co "john", status eq "active"" # 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: **name**: *co* **owner**: *co* **status**: *eq* (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** (optional)
$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 user levels
try {
Get-V2025UserLevels -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2025UserLevels -XSailPointExperimental $XSailPointExperimental -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UserLevels"
Write-Host $_.ErrorDetails
}
- path: /authorization/custom-user-levels/{id}/publish
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#publish-custom-user-level
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Id = "6e110911-5984-491b-be74-2707980a46a7" # String | The unique identifier of the user level to publish.
# Publish a custom user level
try {
Publish-V2025CustomUserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id
# Below is a request that includes all optional parameters
# Publish-V2025CustomUserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2025CustomUserLevel"
Write-Host $_.ErrorDetails
}
- path: /authorization/custom-user-levels/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/custom-user-levels#update-user-level
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Id = "6e110911-5984-491b-be74-2707980a46a7" # String | The unique identifier of the user level.
$JsonPatch = @"
{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}
"@
# Update a user level
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2025UserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2025UserLevel -XSailPointExperimental $XSailPointExperimental -Id $Id -JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025UserLevel"
Write-Host $_.ErrorDetails
}
- path: /data-segments
method: POST
xCodeSample:
@@ -12004,7 +12177,8 @@
{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration"
"name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}
"@
@@ -18716,7 +18890,6 @@
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID.
$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 = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List workflow executions
@@ -18725,7 +18898,7 @@
Get-V2025WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
# Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions"
Write-Host $_.ErrorDetails

View File

@@ -5629,7 +5629,8 @@
{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration"
"name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}
"@
@@ -9940,7 +9941,6 @@
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID.
$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 = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List workflow executions
@@ -9949,7 +9949,7 @@
Get-WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
# Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions"
Write-Host $_.ErrorDetails