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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md
View File

@@ -27,9 +27,12 @@ Method | HTTP request | Description
[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher
[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher
## create-launcher
Create a Launcher with given information
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -71,19 +74,22 @@ $LauncherRequest = @"{
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
New-BetaLauncher -BetaLauncherRequest $Result
New-BetaLauncher -BetaLauncherRequest $Result
# Below is a request that includes all optional parameters
# New-BetaLauncher -BetaLauncherRequest $LauncherRequest
# New-BetaLauncher -BetaLauncherRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-launcher
Delete the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,19 +120,22 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch
# Delete Launcher
try {
Remove-BetaLauncher -BetaLauncherID $LauncherID
Remove-BetaLauncher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Remove-BetaLauncher -BetaLauncherID $LauncherID
# Remove-BetaLauncher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launcher
Get details for the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch
# Get Launcher by ID
try {
Get-BetaLauncher -BetaLauncherID $LauncherID
Get-BetaLauncher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Get-BetaLauncher -BetaLauncherID $LauncherID
# Get-BetaLauncher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launchers
Return a list of Launchers for the authenticated tenant
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -204,19 +216,22 @@ $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10)
# List all Launchers for tenant
try {
Get-BetaLaunchers
Get-BetaLaunchers
# Below is a request that includes all optional parameters
# Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit
# Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-launcher
Replace the given Launcher ID with given payload
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -260,19 +275,22 @@ $LauncherRequest = @"{
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $Result
Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest
# Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-launcher
Launch the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -303,10 +321,10 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch
# Launch a Launcher
try {
Start-BetaLauncher -BetaLauncherID $LauncherID
Start-BetaLauncher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Start-BetaLauncher -BetaLauncherID $LauncherID
# Start-BetaLauncher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher"
Write-Host $_.ErrorDetails