mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Prettified Code!
This commit is contained in:
committed by
GitHub Action
parent
f5b6aaf14f
commit
2cd5ccfc81
@@ -19,7 +19,7 @@ To see a list of available create cmdlets, run this command:
|
||||
Get-Command -Module PSSailpoint | where-object {$_.name -like "*New-*" } | Sort-Object Name | Get-Help | Format-Table Name, Synopsis
|
||||
```
|
||||
|
||||
The SDK returns this output (all beta endpoints are designated by the Beta prefix):
|
||||
The SDK returns this output (all beta endpoints are designated by the Beta prefix):
|
||||
|
||||
```powershell
|
||||
Name Synopsis
|
||||
@@ -60,10 +60,10 @@ $JSON = @"
|
||||
|
||||
$WorkGroup = ConvertFrom-BetaJsonToWorkgroupDto -Json $JSON
|
||||
|
||||
$WorkGroup = Initialize-BetaWorkgroupDto -Name "DB Access Governance Group" -Description "Description of the Governance Group" -Owner @{
|
||||
$WorkGroup = Initialize-BetaWorkgroupDto -Name "DB Access Governance Group" -Description "Description of the Governance Group" -Owner @{
|
||||
"type" = "IDENTITY"
|
||||
"id" = $Identity.id
|
||||
"name" = $Identity.name
|
||||
"name" = $Identity.name
|
||||
}
|
||||
|
||||
New-BetaWorkgroup -WorkgroupDto $WorkGroup
|
||||
@@ -86,6 +86,6 @@ memberCount 0
|
||||
connectionCount 0
|
||||
id a241d625-d948-4c41-839e-869b790837a1
|
||||
name DB Access Governance Group
|
||||
created
|
||||
modified
|
||||
created
|
||||
modified
|
||||
```
|
||||
|
||||
@@ -26,7 +26,7 @@ Using the [WithHttpInfo Switch](./getting-started.md#withhttpinfo-switch) in the
|
||||
```powershell
|
||||
Name Value
|
||||
---- -----
|
||||
Response
|
||||
Response
|
||||
StatusCode 204
|
||||
Headers {[Date, System.String[]], [Connection, System.String[]], [Server, System.String[]], [Vary, System.String[]]…}
|
||||
```
|
||||
|
||||
@@ -18,7 +18,7 @@ You can use a `try/catch` function to intercept any non success response and tak
|
||||
```powershell
|
||||
# Catch any non 2xx response and log the status code and error message
|
||||
try {
|
||||
Get-Transforms -Filters "id eq"
|
||||
Get-Transforms -Filters "id eq"
|
||||
}
|
||||
catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__
|
||||
@@ -33,7 +33,7 @@ This code ensures that the `Get-AccessProfiles` cmdlet will never be called:
|
||||
```powershell
|
||||
# Catch any non 2xx response and log the status code and error message. Stop the script with the Exit keyword.
|
||||
try {
|
||||
Get-Transforms -Filters "id eq"
|
||||
Get-Transforms -Filters "id eq"
|
||||
}
|
||||
catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__
|
||||
|
||||
@@ -71,42 +71,42 @@ Get-Help Get-Transforms -Detailed
|
||||
```text
|
||||
NAME
|
||||
Get-Transforms
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
List transforms
|
||||
|
||||
|
||||
|
||||
|
||||
SYNTAX
|
||||
Get-Transforms [[-Offset] <Nullable`1>] [[-Limit] <Nullable`1>] [[-Count] <Nullable`1>] [[-Name] <String>] [[-Filters] <String>] [-WithHttpInfo] [<CommonParameters>]
|
||||
|
||||
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
Gets a list of all saved transform objects. A token with 'transforms-list read' authority is required to call this API.
|
||||
|
||||
|
||||
|
||||
PARAMETERS
|
||||
-Offset <Nullable`1>
|
||||
Offset into the full result set. Usually specified with *limit* to paginate through the results. For more information, refer to [V3 API Standard Collection
|
||||
Offset into the full result set. Usually specified with *limit* to paginate through the results. For more information, refer to [V3 API Standard Collection
|
||||
Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters).
|
||||
|
||||
|
||||
-Limit <Nullable`1>
|
||||
Max number of results to return. For more information, refer to [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters).
|
||||
|
||||
|
||||
-Count <Nullable`1>
|
||||
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. For more information, refer to [V3 API Standard Collection
|
||||
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. For more information, refer to [V3 API Standard Collection
|
||||
Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters).
|
||||
|
||||
|
||||
-Name <String>
|
||||
Name of the transform to retrieve from the list.
|
||||
|
||||
|
||||
-Filters <String>
|
||||
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results). Filtering is
|
||||
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results). Filtering is
|
||||
supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw*
|
||||
|
||||
|
||||
-WithHttpInfo [<SwitchParameter>]
|
||||
A switch that, when enabled, will return a hash table of Response, StatusCode and Headers, instead of just the Response.
|
||||
|
||||
|
||||
<CommonParameters>
|
||||
This cmdlet supports the common parameters: Verbose, Debug,
|
||||
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
|
||||
|
||||
@@ -32,7 +32,6 @@ try {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
The `Invoke-Paginate` cmdlet takes a few paramters. The first is the cmdlet you wish to call.
|
||||
|
||||
The `-Function` specifies the name of the cmdlet you wish to call. This only works on list endpoints.
|
||||
@@ -43,6 +42,6 @@ The `-Limit` specifies the total number of results you can return, 1000.
|
||||
|
||||
The `-Parameters` specifies a hashtable of additional values passed to the API endpoint. You would use this for `filters`, `sorters`, and any other query parameters.
|
||||
|
||||
You can also provide an `-InitialOffset` value to specify the record number to start the request on. For example, you can provide add `-InitialOffset 10` to start getting accounts from 11 instead of 0.
|
||||
You can also provide an `-InitialOffset` value to specify the record number to start the request on. For example, you can provide add `-InitialOffset 10` to start getting accounts from 11 instead of 0.
|
||||
|
||||
To find out whether an endpoint supports pagination, refer to its documentation. Any API supporting pagination lists the optional query parameters detailed in [Paginating Results](/docs/api/standard-collection-parameters/#paginating-results).
|
||||
|
||||
@@ -11,11 +11,10 @@ slug: /tools/sdk/powershell/retries
|
||||
tags: ['SDK']
|
||||
---
|
||||
|
||||
|
||||
The SDK supports retry logic in the case of an unexpected error. You have these two retry configuration options:
|
||||
|
||||
* MaximumRetryCount - How many times to retry the request. Default is 10 retries.
|
||||
* RetryIntervalSeconds - How many seconds to wait between retries. Default is 5 seconds.
|
||||
- MaximumRetryCount - How many times to retry the request. Default is 10 retries.
|
||||
- RetryIntervalSeconds - How many seconds to wait between retries. Default is 5 seconds.
|
||||
|
||||
The following code will tell the SDK to retry 2 times after an unexpected error and wait 3 seconds between retries.
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ To see a list of available create cmdlets, run this command:
|
||||
Get-Command -Module PSSailpoint | where-object {$_.name -like "*Update-*" } | Sort-Object Name | Get-Help | Format-Table Name, Synopsis
|
||||
```
|
||||
|
||||
The SDK returns this output (all beta endpoints are designated by the Beta prefix):
|
||||
The SDK returns this output (all beta endpoints are designated by the Beta prefix):
|
||||
|
||||
```powershell
|
||||
Name Synopsis
|
||||
|
||||
Reference in New Issue
Block a user