Update PowerShell SDK docs: 16303883694

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

View File

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

View File

@@ -335,7 +335,6 @@ Param Type | Name | Data Type | Required | Description
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 | 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*
### Return type
@@ -361,7 +360,6 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID.
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List workflow executions
@@ -370,7 +368,7 @@ try {
Get-BetaWorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
# Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions"
Write-Host $_.ErrorDetails

View File

@@ -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]
**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]
**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
@@ -26,7 +27,8 @@ Name | Type | Description | Notes
```powershell
$CreatePersonalAccessTokenRequest = Initialize-BetaCreatePersonalAccessTokenRequest -Name NodeJS Integration `
-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

View File

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
**Owner** | [**PatOwner**](pat-owner) | | [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]
**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
@@ -34,7 +35,8 @@ $CreatePersonalAccessTokenResponse = Initialize-BetaCreatePersonalAccessTokenRes
-Name NodeJS Integration `
-Owner null `
-Created 2017-07-11T18:45:37.098Z `
-AccessTokenValiditySeconds 36900
-AccessTokenValiditySeconds 36900 `
-ExpirationDate 2018-01-11T18:45:37.098Z
```
- Convert the resource to JSON

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]
**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]
**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
@@ -34,7 +36,9 @@ $GetPersonalAccessTokenResponse = Initialize-BetaGetPersonalAccessTokenResponse
-Owner null `
-Created 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