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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,3 +1,4 @@
---
id: beta-launchers
title: Launchers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/launchers
tags: ['SDK', 'Software Development Kit', 'Launchers', 'BetaLaunchers']
---
# Launchers
Use this API to manage Launchers.
@@ -28,9 +28,7 @@ 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
### Parameters
@@ -39,7 +37,6 @@ Param Type | Name | Data Type | Required | Description
Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
@@ -54,7 +51,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -71,7 +67,9 @@ $LauncherRequest = @"{
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Create launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
New-BetaLauncher-BetaLauncherRequest $Result
@@ -83,11 +81,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-launcher
Delete the given Launcher ID
### Parameters
@@ -96,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
Path | LauncherID | **String** | True | ID of the Launcher to be deleted
### Return type
(empty response body)
### Responses
@@ -111,14 +105,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
# Delete Launcher
try {
Remove-BetaLauncher-BetaLauncherID $LauncherID
@@ -129,11 +124,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launcher
Get details for the given Launcher ID
### Parameters
@@ -142,7 +134,6 @@ Param Type | Name | Data Type | Required | Description
Path | LauncherID | **String** | True | ID of the Launcher to be retrieved
### Return type
[**Launcher**](../models/launcher)
### Responses
@@ -157,14 +148,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
# Get Launcher by ID
try {
Get-BetaLauncher-BetaLauncherID $LauncherID
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launchers
Return a list of Launchers for the authenticated tenant
### Parameters
@@ -190,7 +179,6 @@ Param Type | Name | Data Type | Required | Description
Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return
### Return type
[**GetLaunchers200Response**](../models/get-launchers200-response)
### Responses
@@ -205,7 +193,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -214,7 +201,9 @@ Code | Description | Data Type
$Filters = 'disabled eq "true"' # 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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
$Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional)
$Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10)
# List all Launchers for tenant
try {
Get-BetaLaunchers
@@ -225,11 +214,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-launcher
Replace the given Launcher ID with given payload
### Parameters
@@ -239,7 +225,6 @@ Path | LauncherID | **String** | True | ID of the Launcher to be replaced
Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
@@ -254,7 +239,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -272,7 +256,9 @@ $LauncherRequest = @"{
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Replace Launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
Send-BetaLauncher-BetaLauncherID $LauncherID -BetaLauncherRequest $Result
@@ -284,11 +270,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-launcher
Launch the given Launcher ID
### Parameters
@@ -297,7 +280,6 @@ Param Type | Name | Data Type | Required | Description
Path | LauncherID | **String** | True | ID of the Launcher to be launched
### Return type
[**StartLauncher200Response**](../models/start-launcher200-response)
### Responses
@@ -312,14 +294,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
# Launch a Launcher
try {
Start-BetaLauncher-BetaLauncherID $LauncherID
@@ -330,7 +313,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)