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

Update PowerShell SDK docs: 16303883694

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md
View File

@@ -66,7 +66,8 @@ Code | Description | Data Type
$CreatePersonalAccessTokenRequest = @"{ $CreatePersonalAccessTokenRequest = @"{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration" "name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}"@ }"@
# Create personal access token # Create personal access token

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md
View File

@@ -335,7 +335,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Workflow ID. Path | Id | **String** | True | Workflow ID.
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 | 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 | 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq*
### Return type ### Return type
@@ -361,7 +360,6 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. $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) $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) $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) $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 # List workflow executions
@@ -370,7 +368,7 @@ try {
Get-BetaWorkflowExecutions -Id $Id Get-BetaWorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/Beta/Models/CreatePersonalAccessTokenRequest.md
View File

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] **Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required]
**Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] **Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -26,7 +27,8 @@ Name | Type | Description | Notes
```powershell ```powershell
$CreatePersonalAccessTokenRequest = Initialize-BetaCreatePersonalAccessTokenRequest -Name NodeJS Integration ` $CreatePersonalAccessTokenRequest = Initialize-BetaCreatePersonalAccessTokenRequest -Name NodeJS Integration `
-Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/Beta/Models/CreatePersonalAccessTokenResponse.md
View File

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
**Owner** | [**PatOwner**](pat-owner) | | [required] **Owner** | [**PatOwner**](pat-owner) | | [required]
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [required]
## Examples ## Examples
@@ -34,7 +35,8 @@ $CreatePersonalAccessTokenResponse = Initialize-BetaCreatePersonalAccessTokenRes
-Name NodeJS Integration ` -Name NodeJS Integration `
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/Beta/Models/GetPersonalAccessTokenResponse.md
View File

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] **LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional]
**Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] **Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] [default to 43200]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -34,7 +36,9 @@ $GetPersonalAccessTokenResponse = Initialize-BetaGetPersonalAccessTokenResponse
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-LastUsed 2017-07-11T18:45:37.098Z ` -LastUsed 2017-07-11T18:45:37.098Z `
-Managed false -Managed false `
-AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

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

@@ -66,7 +66,8 @@ Code | Description | Data Type
$CreatePersonalAccessTokenRequest = @"{ $CreatePersonalAccessTokenRequest = @"{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration" "name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}"@ }"@
# Create personal access token # Create personal access token

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

@@ -432,7 +432,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Workflow ID. Path | Id | **String** | True | Workflow ID.
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 | 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 | 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
### Return type ### Return type
@@ -458,7 +457,6 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. $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) $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) $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) $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 # List workflow executions
@@ -467,7 +465,7 @@ try {
Get-V2024WorkflowExecutions -Id $Id Get-V2024WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

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

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] **Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required]
**Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] **Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -26,7 +27,8 @@ Name | Type | Description | Notes
```powershell ```powershell
$CreatePersonalAccessTokenRequest = Initialize-V2024CreatePersonalAccessTokenRequest -Name NodeJS Integration ` $CreatePersonalAccessTokenRequest = Initialize-V2024CreatePersonalAccessTokenRequest -Name NodeJS Integration `
-Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

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

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
**Owner** | [**PatOwner**](pat-owner) | | [required] **Owner** | [**PatOwner**](pat-owner) | | [required]
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [required]
## Examples ## Examples
@@ -34,7 +35,8 @@ $CreatePersonalAccessTokenResponse = Initialize-V2024CreatePersonalAccessTokenRe
-Name NodeJS Integration ` -Name NodeJS Integration `
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

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

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] **LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional]
**Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] **Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] [default to 43200]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -34,7 +36,9 @@ $GetPersonalAccessTokenResponse = Initialize-V2024GetPersonalAccessTokenResponse
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-LastUsed 2017-07-11T18:45:37.098Z ` -LastUsed 2017-07-11T18:45:37.098Z `
-Managed false -Managed false `
-AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

427
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomUserLevelsApi.md Normal file
View File

@@ -0,0 +1,427 @@
---
id: v2025-custom-user-levels
title: CustomUserLevels
pagination_label: CustomUserLevels
sidebar_label: CustomUserLevels
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'CustomUserLevels', 'V2025CustomUserLevels']
slug: /tools/sdk/powershell/v2025/methods/custom-user-levels
tags: ['SDK', 'Software Development Kit', 'CustomUserLevels', 'V2025CustomUserLevels']
---
# CustomUserLevels
Use this API to implement custom user level functionality.
With this functionality in place, administrators can create custom user levels and configure them for use throughout Identity Security Cloud.
Custom user levels allow administrators to create custom user levels that can be used to control access to Identity Security Cloud features and APIs.
Refer to [User Levels](https://documentation.sailpoint.com/saas/help/common/users/index.html) for more information about User Levels.
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2025CustomUserLevel**](#create-custom-user-level) | **POST** `/authorization/custom-user-levels` | Create a custom user level
[**Remove-V2025UserLevel**](#delete-user-level) | **DELETE** `/authorization/custom-user-levels/{id}` | Delete a user level
[**Get-V2025UserLevel**](#get-user-level) | **GET** `/authorization/custom-user-levels/{id}` | Retrieve a user level
[**Get-V2025AllAuthorizationRightSets**](#list-all-authorization-right-sets) | **GET** `/authorization/authorization-assignable-right-sets` | List all uiAssignable right sets
[**Get-V2025UserLevels**](#list-user-levels) | **GET** `/authorization/custom-user-levels` | List user levels
[**Publish-V2025CustomUserLevel**](#publish-custom-user-level) | **POST** `/authorization/custom-user-levels/{id}/publish` | Publish a custom user level
[**Update-V2025UserLevel**](#update-user-level) | **PATCH** `/authorization/custom-user-levels/{id}` | Update a user level
## create-custom-user-level
:::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.
:::
Creates a new custom user level for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-custom-user-level)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | UserLevelRequest | [**UserLevelRequest**](../models/user-level-request) | True | Payload containing the details of the user level to be created.
### Return type
[**UserLevelSummaryDTO**](../models/user-level-summary-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The user level summary. | UserLevelSummaryDTO
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
$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
}
```
[[Back to top]](#)
## delete-user-level
:::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.
:::
Deletes a specific user level by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-user-level)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Path | Id | **String** | True | The unique identifier of the user level.
### 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
$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
}
```
[[Back to top]](#)
## get-user-level
:::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.
:::
Fetches the details of a specific user level by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-user-level)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Path | Id | **String** | True | The unique identifier of the user level.
### Return type
[**UserLevelSummaryDTO**](../models/user-level-summary-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Successfully retrieved the user level details. | UserLevelSummaryDTO
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")
$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
}
```
[[Back to top]](#)
## list-all-authorization-right-sets
:::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.
:::
Retrieves a list of authorization assignable right sets for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-all-authorization-right-sets)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
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: **category**: *eq*
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, category**
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
[**HierarchicalRightSet[]**](../models/hierarchical-right-set)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Successfully retrieved the list of authorization assignable right sets. | HierarchicalRightSet[]
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")
$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
}
```
[[Back to top]](#)
## list-user-levels
:::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.
:::
Retrieves a list of user levels for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-user-levels)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | DetailLevel | **String** | (optional) | Specifies the level of detail for the user levels.
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: **name**: *co* **owner**: *co* **status**: *eq*
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**
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
[**UserLevelSummaryDTO[]**](../models/user-level-summary-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Successfully retrieved the list of user levels. | UserLevelSummaryDTO[]
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")
$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
}
```
[[Back to top]](#)
## publish-custom-user-level
:::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.
:::
Publishes a custom user level for the tenant, making it active and available.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/publish-custom-user-level)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Path | Id | **String** | True | The unique identifier of the user level to publish.
### Return type
[**UserLevelPublishSummary**](../models/user-level-publish-summary)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The publish status summary for current user level. | UserLevelPublishSummary
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")
$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
}
```
[[Back to top]](#)
## update-user-level
:::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.
:::
Updates the details of a specific user level using JSON Patch.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-user-level)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Path | Id | **String** | True | The unique identifier of the user level.
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | JSON Patch payload for updating the user level.
### Return type
[**UserLevelSummaryDTO**](../models/user-level-summary-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Successfully updated the user level. | UserLevelSummaryDTO
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
$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
}
```
[[Back to top]](#)

3
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PersonalAccessTokensApi.md
View File

@@ -66,7 +66,8 @@ Code | Description | Data Type
$CreatePersonalAccessTokenRequest = @"{ $CreatePersonalAccessTokenRequest = @"{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration" "name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}"@ }"@
# Create personal access token # Create personal access token

4
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md
View File

@@ -426,7 +426,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Workflow ID. Path | Id | **String** | True | Workflow ID.
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 | 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 | 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
### Return type ### Return type
@@ -452,7 +451,6 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. $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) $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) $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) $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 # List workflow executions
@@ -461,7 +459,7 @@ try {
Get-V2025WorkflowExecutions -Id $Id Get-V2025WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2025/Models/CreatePersonalAccessTokenRequest.md
View File

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] **Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required]
**Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] **Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -26,7 +27,8 @@ Name | Type | Description | Notes
```powershell ```powershell
$CreatePersonalAccessTokenRequest = Initialize-V2025CreatePersonalAccessTokenRequest -Name NodeJS Integration ` $CreatePersonalAccessTokenRequest = Initialize-V2025CreatePersonalAccessTokenRequest -Name NodeJS Integration `
-Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V2025/Models/CreatePersonalAccessTokenResponse.md
View File

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
**Owner** | [**PatOwner**](pat-owner) | | [required] **Owner** | [**PatOwner**](pat-owner) | | [required]
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [required]
## Examples ## Examples
@@ -34,7 +35,8 @@ $CreatePersonalAccessTokenResponse = Initialize-V2025CreatePersonalAccessTokenRe
-Name NodeJS Integration ` -Name NodeJS Integration `
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/V2025/Models/GetPersonalAccessTokenResponse.md
View File

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] **LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional]
**Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] **Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] [default to 43200]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -34,7 +36,9 @@ $GetPersonalAccessTokenResponse = Initialize-V2025GetPersonalAccessTokenResponse
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-LastUsed 2017-07-11T18:45:37.098Z ` -LastUsed 2017-07-11T18:45:37.098Z `
-Managed false -Managed false `
-AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

45
docs/tools/sdk/powershell/Reference/V2025/Models/HierarchicalRightSet.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2025-hierarchical-right-set
title: HierarchicalRightSet
pagination_label: HierarchicalRightSet
sidebar_label: HierarchicalRightSet
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'HierarchicalRightSet', 'V2025HierarchicalRightSet']
slug: /tools/sdk/powershell/v2025/models/hierarchical-right-set
tags: ['SDK', 'Software Development Kit', 'HierarchicalRightSet', 'V2025HierarchicalRightSet']
---
# HierarchicalRightSet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique identifier of the RightSet. | [optional]
**Name** | **String** | The human-readable name of the RightSet. | [optional]
**Description** | **String** | A human-readable description of the RightSet. | [optional]
**Category** | **String** | The category of the RightSet. | [optional]
**NestedConfig** | [**NestedConfig**](nested-config) | | [optional]
**Children** | [**[]HierarchicalRightSet**](hierarchical-right-set) | List of child HierarchicalRightSets. | [optional]
## Examples
- Prepare the resource
```powershell
$HierarchicalRightSet = Initialize-V2025HierarchicalRightSet -Id idn:ui-right-set-example `
-Name Hierarchical Right Set Name `
-Description This is a description of the HierarchicalRightSet. `
-Category identity `
-NestedConfig null `
-Children {id=idn:ui-identity-details-example, name=Identity Details, description=Read only access for identity details., category=identity, nestedConfig={ancestorId=idn:ui-identity-management-example, depth=1, parentId=idn:ui-identity-management-example, childrenIds=[]}, children=[]}
```
- Convert the resource to JSON
```powershell
$HierarchicalRightSet | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2025/Models/NestedConfig.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2025-nested-config
title: NestedConfig
pagination_label: NestedConfig
sidebar_label: NestedConfig
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'NestedConfig', 'V2025NestedConfig']
slug: /tools/sdk/powershell/v2025/models/nested-config
tags: ['SDK', 'Software Development Kit', 'NestedConfig', 'V2025NestedConfig']
---
# NestedConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AncestorId** | **String** | The unique identifier of the ancestor RightSet. | [optional]
**Depth** | **Int32** | The depth level of the configuration. | [optional]
**ParentId** | **String** | The unique identifier of the parent RightSet. | [optional]
**ChildrenIds** | **[]String** | List of unique identifiers for child configurations. | [optional]
## Examples
- Prepare the resource
```powershell
$NestedConfig = Initialize-V2025NestedConfig -AncestorId idn:ui-ancestor-example `
-Depth 2 `
-ParentId idn:ui-parent-example `
-ChildrenIds [idn:ui-child-one-example, idn:ui-child-two-example]
```
- Convert the resource to JSON
```powershell
$NestedConfig | ConvertTo-JSON
```
[[Back to top]](#)

55
docs/tools/sdk/powershell/Reference/V2025/Models/RightSetDTO.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: v2025-right-set-dto
title: RightSetDTO
pagination_label: RightSetDTO
sidebar_label: RightSetDTO
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'RightSetDTO', 'V2025RightSetDTO']
slug: /tools/sdk/powershell/v2025/models/right-set-dto
tags: ['SDK', 'Software Development Kit', 'RightSetDTO', 'V2025RightSetDTO']
---
# RightSetDTO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique identifier of the RightSet. | [optional]
**Name** | **String** | The human-readable name of the RightSet. | [optional]
**Description** | **String** | A human-readable description of the RightSet. | [optional]
**Category** | **String** | The category of the RightSet. | [optional]
**Rights** | **[]String** | Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. | [optional]
**RightSetIds** | **[]String** | List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. | [optional]
**UiAssignableChildRightSetIds** | **[]String** | List of unique identifiers for UI-assignable child RightSets, used to build UI components. | [optional]
**UiAssignable** | **Boolean** | Indicates whether the RightSet is UI-assignable. | [optional] [default to $false]
**TranslatedName** | **String** | The translated name of the RightSet. | [optional]
**TranslatedDescription** | **String** | The translated description of the RightSet. | [optional]
**ParentId** | **String** | The unique identifier of the parent RightSet for UI Assignable RightSet. | [optional]
## Examples
- Prepare the resource
```powershell
$RightSetDTO = Initialize-V2025RightSetDTO -Id idn:ui-right-set-example `
-Name Right Set Name `
-Description This is a description of the RightSet. `
-Category identity `
-Rights [idn:ui-right-set-example:read, idn:ui-right-set-example:write] `
-RightSetIds [idn:ui-right-set-example-update, idn:ui-right-set-example-delete] `
-UiAssignableChildRightSetIds [idn:ui-right-set-example-detail, idn:ui-right-set-example-management] `
-UiAssignable true `
-TranslatedName Translated Right Set Name `
-TranslatedDescription This is a translated description of the RightSet. `
-ParentId idn:ui-parent-example
```
- Convert the resource to JSON
```powershell
$RightSetDTO | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2025/Models/UserLevelPublishSummary.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2025-user-level-publish-summary
title: UserLevelPublishSummary
pagination_label: UserLevelPublishSummary
sidebar_label: UserLevelPublishSummary
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'UserLevelPublishSummary', 'V2025UserLevelPublishSummary']
slug: /tools/sdk/powershell/v2025/models/user-level-publish-summary
tags: ['SDK', 'Software Development Kit', 'UserLevelPublishSummary', 'V2025UserLevelPublishSummary']
---
# UserLevelPublishSummary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**UserLevelId** | **String** | The unique identifier of the UserLevel. | [optional]
**Publish** | **Boolean** | Indicates whether the API call triggered a publish operation. | [optional] [default to $false]
**Status** | **String** | The status of the UserLevel publish operation. | [optional]
**Modified** | **System.DateTime** | The last modification timestamp of the UserLevel. | [optional]
## Examples
- Prepare the resource
```powershell
$UserLevelPublishSummary = Initialize-V2025UserLevelPublishSummary -UserLevelId 6e110911-5984-491b-be74-2707980a46a7 `
-Publish true `
-Status ACTIVE `
-Modified 2023-01-02T12:00Z
```
- Convert the resource to JSON
```powershell
$UserLevelPublishSummary | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2025/Models/UserLevelRequest.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2025-user-level-request
title: UserLevelRequest
pagination_label: UserLevelRequest
sidebar_label: UserLevelRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'UserLevelRequest', 'V2025UserLevelRequest']
slug: /tools/sdk/powershell/v2025/models/user-level-request
tags: ['SDK', 'Software Development Kit', 'UserLevelRequest', 'V2025UserLevelRequest']
---
# UserLevelRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | The name of the user level. | [required]
**Description** | **String** | A brief description of the user level. | [required]
**Owner** | [**BaseReferenceDto**](base-reference-dto) | | [required]
**RightSets** | **[]String** | A list of rights associated with the user level. | [optional]
## Examples
- Prepare the resource
```powershell
$UserLevelRequest = Initialize-V2025UserLevelRequest -Name Custom User Level Name `
-Description This is a description of the custom user level. `
-Owner null `
-RightSets [idn:ui-right-set-list-read-example, idn:ui-right-set-write-example]
```
- Convert the resource to JSON
```powershell
$UserLevelRequest | ConvertTo-JSON
```
[[Back to top]](#)

63
docs/tools/sdk/powershell/Reference/V2025/Models/UserLevelSummaryDTO.md Normal file
View File

@@ -0,0 +1,63 @@
---
id: v2025-user-level-summary-dto
title: UserLevelSummaryDTO
pagination_label: UserLevelSummaryDTO
sidebar_label: UserLevelSummaryDTO
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'UserLevelSummaryDTO', 'V2025UserLevelSummaryDTO']
slug: /tools/sdk/powershell/v2025/models/user-level-summary-dto
tags: ['SDK', 'Software Development Kit', 'UserLevelSummaryDTO', 'V2025UserLevelSummaryDTO']
---
# UserLevelSummaryDTO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique identifier of the UserLevel. | [optional]
**Name** | **String** | The human-readable name of the UserLevel. | [optional]
**Description** | **String** | A human-readable description of the UserLevel. | [optional]
**LegacyGroup** | **String** | The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. | [optional]
**RightSets** | [**[]RightSetDTO**](right-set-dto) | List of RightSets associated with the UserLevel. | [optional]
**Custom** | **Boolean** | Indicates whether the UserLevel is custom. | [optional] [default to $true]
**AdminAssignable** | **Boolean** | Indicates whether the UserLevel is admin-assignable. | [optional] [default to $true]
**TranslatedName** | **String** | The translated name of the UserLevel. | [optional]
**TranslatedGrant** | **String** | The translated grant message for the UserLevel. | [optional]
**TranslatedRemove** | **String** | The translated remove message for the UserLevel. | [optional]
**Owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Status** | **Enum** [ "ACTIVE", "DRAFT" ] | The status of the UserLevel. | [optional]
**Created** | **System.DateTime** | The creation timestamp of the UserLevel. | [optional]
**Modified** | **System.DateTime** | The last modification timestamp of the UserLevel. | [optional]
**AssociatedIdentitiesCount** | **Int32** | The count of associated identities for the UserLevel. | [optional]
## Examples
- Prepare the resource
```powershell
$UserLevelSummaryDTO = Initialize-V2025UserLevelSummaryDTO -Id beb02a57-010f-4c29-a6d2-fae9628bda73 `
-Name Custom User Level Name `
-Description This is a description of the CustomUserLevel. `
-LegacyGroup ORG_ADMIN `
-RightSets null `
-Custom true `
-AdminAssignable true `
-TranslatedName Translated Custom User Level Name `
-TranslatedGrant Grant Message `
-TranslatedRemove Remove Message `
-Owner null `
-Status Active `
-Created 2023-01-01T12:00Z `
-Modified 2023-01-02T12:00Z `
-AssociatedIdentitiesCount 10
```
- Convert the resource to JSON
```powershell
$UserLevelSummaryDTO | ConvertTo-JSON
```
[[Back to top]](#)

3
docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md
View File

@@ -66,7 +66,8 @@ Code | Description | Data Type
$CreatePersonalAccessTokenRequest = @"{ $CreatePersonalAccessTokenRequest = @"{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration" "name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}"@ }"@
# Create personal access token # Create personal access token

4
docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md
View File

@@ -428,7 +428,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Workflow ID. Path | Id | **String** | True | Workflow ID.
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 | 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 | 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
### Return type ### Return type
@@ -454,7 +453,6 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. $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) $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) $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) $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 # List workflow executions
@@ -463,7 +461,7 @@ try {
Get-WorkflowExecutions -Id $Id Get-WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V3/Models/CreatePersonalAccessTokenRequest.md
View File

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] **Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required]
**Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] **Scope** | **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -26,7 +27,8 @@ Name | Type | Description | Notes
```powershell ```powershell
$CreatePersonalAccessTokenRequest = Initialize-CreatePersonalAccessTokenRequest -Name NodeJS Integration ` $CreatePersonalAccessTokenRequest = Initialize-CreatePersonalAccessTokenRequest -Name NodeJS Integration `
-Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V3/Models/CreatePersonalAccessTokenResponse.md
View File

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
**Owner** | [**PatOwner**](pat-owner) | | [required] **Owner** | [**PatOwner**](pat-owner) | | [required]
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] **AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [required]
## Examples ## Examples
@@ -34,7 +35,8 @@ $CreatePersonalAccessTokenResponse = Initialize-CreatePersonalAccessTokenRespons
-Name NodeJS Integration ` -Name NodeJS Integration `
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-AccessTokenValiditySeconds 36900 -AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/V3/Models/GetPersonalAccessTokenResponse.md
View File

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] **Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required]
**LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] **LastUsed** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional]
**Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] **Managed** | **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false]
**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] [default to 43200]
**ExpirationDate** | **System.DateTime** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [optional]
## Examples ## Examples
@@ -34,7 +36,9 @@ $GetPersonalAccessTokenResponse = Initialize-GetPersonalAccessTokenResponse -Id
-Owner null ` -Owner null `
-Created 2017-07-11T18:45:37.098Z ` -Created 2017-07-11T18:45:37.098Z `
-LastUsed 2017-07-11T18:45:37.098Z ` -LastUsed 2017-07-11T18:45:37.098Z `
-Managed false -Managed false `
-AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

6
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

@@ -9214,7 +9214,8 @@
{ {
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "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. $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) $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) $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) $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 # List workflow executions
@@ -14486,7 +14486,7 @@
Get-BetaWorkflowExecutions -Id $Id Get-BetaWorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

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

@@ -11906,7 +11906,8 @@
{ {
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "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. $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) $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) $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) $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 # List workflow executions
@@ -18627,7 +18627,7 @@
Get-V2024WorkflowExecutions -Id $Id Get-V2024WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

179
static/code-examples/v2025/powershell_code_examples_overlay.yaml
View File

@@ -5128,6 +5128,179 @@
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions"
Write-Host $_.ErrorDetails 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 - path: /data-segments
method: POST method: POST
xCodeSample: xCodeSample:
@@ -12004,7 +12177,8 @@
{ {
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "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. $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) $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) $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) $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 # List workflow executions
@@ -18725,7 +18898,7 @@
Get-V2025WorkflowExecutions -Id $Id Get-V2025WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

6
static/code-examples/v3/powershell_code_examples_overlay.yaml
View File

@@ -5629,7 +5629,8 @@
{ {
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900, "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. $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) $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) $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) $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 # List workflow executions
@@ -9949,7 +9949,7 @@
Get-WorkflowExecutions -Id $Id Get-WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters # 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 { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails