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

Update to powershell SDK docs: 14084874744

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-26 13:45:58 +00:00
parent e44badae35
commit fe4aab85d6
2 changed files with 72 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -4150,7 +4150,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @"
{
"owner" : {
@@ -4268,10 +4267,10 @@
# Creates a form definition.
try {
New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental
New-V2024FormDefinition
# Below is a request that includes all optional parameters
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result
# New-V2024FormDefinition -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
Write-Host $_.ErrorDetails
@@ -4282,7 +4281,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @"
{
"description" : "A description",
@@ -4298,10 +4296,10 @@
# Generate JSON Schema dynamically.
try {
New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental
New-V2024FormDefinitionDynamicSchema
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result
# New-V2024FormDefinitionDynamicSchema -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
Write-Host $_.ErrorDetails
@@ -4313,16 +4311,15 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file.
try {
New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File
New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest"
Write-Host $_.ErrorDetails
@@ -4333,7 +4330,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @"
{
"formInput" : {
@@ -4361,10 +4357,10 @@
# Creates a form instance.
try {
New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental
New-V2024FormInstance
# Below is a request that includes all optional parameters
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result
# New-V2024FormInstance -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
Write-Host $_.ErrorDetails
@@ -4376,15 +4372,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Deletes a form definition.
try {
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition"
Write-Host $_.ErrorDetails
@@ -4395,7 +4390,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit 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) (default to 250)
$Filters = "name sw "my form"" # 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**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -4404,10 +4398,10 @@
# List form definitions by tenant.
try {
Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental
Export-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters
# Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
# Export-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails
@@ -4420,15 +4414,14 @@
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download definition file by fileId.
try {
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
# Below is a request that includes all optional parameters
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3"
Write-Host $_.ErrorDetails
@@ -4440,15 +4433,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return a form definition.
try {
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey"
Write-Host $_.ErrorDetails
@@ -4460,15 +4452,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key
source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Returns a form instance.
try {
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey"
Write-Host $_.ErrorDetails
@@ -4481,15 +4472,14 @@
source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download instance file by fileId.
try {
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
# Below is a request that includes all optional parameters
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile"
Write-Host $_.ErrorDetails
@@ -4500,7 +4490,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
@@ -4513,10 +4502,10 @@
# Import form definitions from export.
try {
Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental
Import-V2024FormDefinitions
# Below is a request that includes all optional parameters
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result
# Import-V2024FormDefinitions -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
Write-Host $_.ErrorDetails
@@ -4528,7 +4517,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/description, value=test-description}]"@
@@ -4536,10 +4524,10 @@
# Patch a form definition.
try {
Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition"
Write-Host $_.ErrorDetails
@@ -4551,7 +4539,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance
source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@
@@ -4559,10 +4546,10 @@
# Patch a form instance.
try {
Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
Update-V2024FormInstance -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance"
Write-Host $_.ErrorDetails
@@ -4573,7 +4560,6 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit 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) (default to 250)
$Filters = "name sw "my form"" # 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**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -4582,10 +4568,10 @@
# Export form definitions by tenant.
try {
Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental
Search-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters
# Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
# Search-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails
@@ -4598,7 +4584,6 @@
source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$FormElementID = "1" # String | Form element ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int64 | Limit 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) (default to 250)
$Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional)
$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
@@ -4606,10 +4591,10 @@
# Retrieves dynamic data by element.
try {
Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental
Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID
# Below is a request that includes all optional parameters
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID"
Write-Host $_.ErrorDetails
@@ -4620,15 +4605,14 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List form instances by tenant.
try {
Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental
Search-V2024FormInstancesByTenant
# Below is a request that includes all optional parameters
# Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental
# Search-V2024FormInstancesByTenant
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant"
Write-Host $_.ErrorDetails
@@ -4639,15 +4623,14 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List predefined select options.
try {
Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental
Search-V2024PreDefinedSelectOptions
# Below is a request that includes all optional parameters
# Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental
# Search-V2024PreDefinedSelectOptions
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions"
Write-Host $_.ErrorDetails
@@ -4659,7 +4642,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 10 # Int64 | Limit 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) (default to 10)
$Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional)
$Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
@@ -4680,10 +4662,10 @@
# Preview form definition data source.
try {
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
Write-Host $_.ErrorDetails