mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update PowerShell SDK docs: 16967723041
This commit is contained in:
developer-relations-sp
@@ -38,6 +38,7 @@ Method | HTTP request | Description
|
||||
[**Close-V2024AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close access request
|
||||
[**New-V2024AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit access request
|
||||
[**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
|
||||
[**Get-V2024EntitlementDetailsForIdentity**](#get-entitlement-details-for-identity) | **GET** `/revocable-objects` | Identity entitlement details
|
||||
[**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
|
||||
[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators
|
||||
[**Invoke-V2024LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity
|
||||
@@ -541,6 +542,59 @@ try {
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-entitlement-details-for-identity
|
||||
:::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.
|
||||
:::
|
||||
Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-details-for-identity)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Path | IdentityId | **String** | True | The identity ID.
|
||||
Path | EntitlementId | **String** | True | The entitlement ID
|
||||
|
||||
### Return type
|
||||
[**IdentityEntitlementDetails**](../models/identity-entitlement-details)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Entitlement and Account Reference | IdentityEntitlementDetails
|
||||
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")
|
||||
$IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID.
|
||||
$EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID
|
||||
|
||||
# Identity entitlement details
|
||||
|
||||
try {
|
||||
Get-V2024EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDetailsForIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-access-request-status
|
||||
Use this API to return a list of access request statuses based on the specified query parameters.
|
||||
If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses.
|
||||
@@ -676,6 +730,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## load-account-selections
|
||||
:::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.
|
||||
:::
|
||||
Use this API to fetch account information for an identity against the items in an access request.
|
||||
|
||||
Used to fetch accountSelection for the AccessRequest prior to submitting for async processing.
|
||||
@@ -686,6 +743,7 @@ Used to fetch accountSelection for the AccessRequest prior to submitting for asy
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -707,6 +765,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$AccountsSelectionRequest = @"{
|
||||
"requestedFor" : "2c918084660f45d6016617daa9210584",
|
||||
"clientMetadata" : {
|
||||
@@ -776,10 +835,10 @@ $AccountsSelectionRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest
|
||||
Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
Invoke-V2024LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
# Invoke-V2024LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -37,6 +37,7 @@ Method | HTTP request | Description
|
||||
[**Get-V2024IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
|
||||
[**Get-V2024RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
|
||||
[**Get-V2024RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
|
||||
[**Get-V2024EntitlementsByIdentity**](#list-entitlements-by-identity) | **GET** `/entitlements/identities/{id}/entitlements` | List of entitlements by identity.
|
||||
[**Get-V2024Identities**](#list-identities) | **GET** `/identities` | List identities
|
||||
[**Reset-V2024Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
|
||||
[**Send-V2024IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
|
||||
@@ -283,6 +284,58 @@ try {
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-entitlements-by-identity
|
||||
The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements-by-identity)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Identity 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.
|
||||
|
||||
### Return type
|
||||
[**IdentityEntitlements[]**](../models/identity-entitlements)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of all Entitlements for given Identity | IdentityEntitlements[]
|
||||
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
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity 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)
|
||||
|
||||
# List of entitlements by identity.
|
||||
|
||||
try {
|
||||
Get-V2024EntitlementsByIdentity -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024EntitlementsByIdentity -Id $Id -Limit $Limit -Offset $Offset -Count $Count
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsByIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-identities
|
||||
This API returns a list of identities.
|
||||
|
||||
@@ -443,6 +496,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-identities-invite
|
||||
:::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.
|
||||
:::
|
||||
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
|
||||
|
||||
This task will send an invitation email only for unregistered identities.
|
||||
@@ -455,6 +511,7 @@ The executed task status can be checked by Task Management > [Get task status by
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -477,6 +534,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$InviteIdentitiesRequest = @"{
|
||||
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
|
||||
"uninvited" : false
|
||||
@@ -486,10 +544,10 @@ $InviteIdentitiesRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
|
||||
Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
# Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -287,9 +287,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## generate-identity-preview
|
||||
:::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.
|
||||
:::
|
||||
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/generate-identity-preview)
|
||||
@@ -297,7 +294,6 @@ This generates a non-persisted IdentityDetails object that will represent as the
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
|
||||
|
||||
### Return type
|
||||
@@ -319,7 +315,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentityPreviewRequest = @"{
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
"identityAttributeConfig" : {
|
||||
@@ -352,10 +347,10 @@ $IdentityPreviewRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
|
||||
New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
New-V2024IdentityPreview -IdentityPreviewRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
# New-V2024IdentityPreview -IdentityPreviewRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -0,0 +1,330 @@
|
||||
---
|
||||
id: v2024-launchers
|
||||
title: Launchers
|
||||
pagination_label: Launchers
|
||||
sidebar_label: Launchers
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Launchers', 'V2024Launchers']
|
||||
slug: /tools/sdk/powershell/v2024/methods/launchers
|
||||
tags: ['SDK', 'Software Development Kit', 'Launchers', 'V2024Launchers']
|
||||
---
|
||||
|
||||
# Launchers
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2024Launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
|
||||
[**Remove-V2024Launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
|
||||
[**Get-V2024Launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
|
||||
[**Get-V2024Launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
|
||||
[**Send-V2024Launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
|
||||
[**Start-V2024Launcher**](#start-launcher) | **POST** `/launchers/{launcherID}/launch` | Launch a launcher
|
||||
|
||||
|
||||
## create-launcher
|
||||
Create a Launcher with given information
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-launcher)
|
||||
|
||||
### Parameters
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
201 | Launcher created successfully | Launcher
|
||||
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
|
||||
$LauncherRequest = @"{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}"@
|
||||
|
||||
# Create launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
New-V2024Launcher -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024Launcher -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-launcher
|
||||
Delete the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-launcher)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | LauncherID | **String** | True | ID of the Launcher to be deleted
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | Launcher deleted successfully |
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
|
||||
|
||||
# Delete launcher
|
||||
|
||||
try {
|
||||
Remove-V2024Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-launcher
|
||||
Get details for the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-launcher)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | LauncherID | **String** | True | ID of the Launcher to be retrieved
|
||||
|
||||
### Return type
|
||||
[**Launcher**](../models/launcher)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Launcher retrieved successfully | Launcher
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
|
||||
|
||||
# Get launcher by id
|
||||
|
||||
try {
|
||||
Get-V2024Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Launcher"
|
||||
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/v2024/get-launchers)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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: **description**: *sw* **disabled**: *eq* **name**: *sw*
|
||||
Query | Next | **String** | (optional) | Pagination marker
|
||||
Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return
|
||||
|
||||
### Return type
|
||||
[**GetLaunchers200Response**](../models/get-launchers200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of Launchers | GetLaunchers200Response
|
||||
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
|
||||
$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-V2024Launchers
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Launchers -Filters $Filters -Next $Next -Limit $Limit
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Launchers"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-launcher
|
||||
Replace the given Launcher ID with given payload
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-launcher)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Launcher replaced successfully | Launcher
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced
|
||||
$LauncherRequest = @"{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}"@
|
||||
|
||||
# Replace launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
Send-V2024Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2024Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-launcher
|
||||
Launch the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-launcher)
|
||||
|
||||
### Parameters
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Launcher launched successfully | StartLauncher200Response
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
|
||||
|
||||
# Launch a launcher
|
||||
|
||||
try {
|
||||
Start-V2024Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2024Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -0,0 +1,237 @@
|
||||
---
|
||||
id: v2024-tags
|
||||
title: Tags
|
||||
pagination_label: Tags
|
||||
sidebar_label: Tags
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Tags', 'V2024Tags']
|
||||
slug: /tools/sdk/powershell/v2024/methods/tags
|
||||
tags: ['SDK', 'Software Development Kit', 'Tags', 'V2024Tags']
|
||||
---
|
||||
|
||||
# Tags
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2024Tag**](#create-tag) | **POST** `/tags` | Create tag
|
||||
[**Remove-V2024TagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
|
||||
[**Get-V2024TagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
|
||||
[**Get-V2024Tags**](#list-tags) | **GET** `/tags` | List tags
|
||||
|
||||
|
||||
## create-tag
|
||||
This API creates new tag.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-tag)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | Tag | [**Tag**](../models/tag) | True |
|
||||
|
||||
### Return type
|
||||
[**Tag**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
201 | Created tag. | Tag
|
||||
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
|
||||
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
|
||||
$Tag = @"{
|
||||
"created" : "2022-05-04T14:48:49Z",
|
||||
"tagCategoryRefs" : [ {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
}, {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
} ],
|
||||
"name" : "PCI",
|
||||
"modified" : "2022-07-14T16:31:11Z",
|
||||
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
|
||||
}"@
|
||||
|
||||
# Create tag
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToTag -Json $Tag
|
||||
New-V2024Tag -Tag $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024Tag -Tag $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Tag"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-tag-by-id
|
||||
This API deletes a tag by specified id.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tag-by-id)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of the object reference to delete.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | No content. |
|
||||
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
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
|
||||
|
||||
# Delete tag
|
||||
|
||||
try {
|
||||
Remove-V2024TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-tag-by-id
|
||||
Returns a tag by its id.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tag-by-id)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of the object reference to retrieve.
|
||||
|
||||
### Return type
|
||||
[**Tag**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Tag | Tag
|
||||
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
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
|
||||
|
||||
# Get tag by id
|
||||
|
||||
try {
|
||||
Get-V2024TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-tags
|
||||
This API returns a list of tags.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tags)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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: **id**: *eq, in* **name**: *eq, in, sw*
|
||||
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, created, modified**
|
||||
|
||||
### Return type
|
||||
[**Tag[]**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of all tags. | Tag[]
|
||||
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
|
||||
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
|
||||
$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 = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # 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: **id**: *eq, in* **name**: *eq, in, sw* (optional)
|
||||
$Sorters = "name,-modified" # 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, created, modified** (optional)
|
||||
|
||||
# List tags
|
||||
|
||||
try {
|
||||
Get-V2024Tags
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Tags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tags"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-get-launchers200-response
|
||||
title: GetLaunchers200Response
|
||||
pagination_label: GetLaunchers200Response
|
||||
sidebar_label: GetLaunchers200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'GetLaunchers200Response', 'V2024GetLaunchers200Response']
|
||||
slug: /tools/sdk/powershell/v2024/models/get-launchers200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'V2024GetLaunchers200Response']
|
||||
---
|
||||
|
||||
|
||||
# GetLaunchers200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Next** | **String** | Pagination marker | [optional]
|
||||
**Items** | [**[]Launcher**](launcher) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$GetLaunchers200Response = Initialize-V2024GetLaunchers200Response -Next null `
|
||||
-Items null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$GetLaunchers200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-identity-entitlement-details
|
||||
title: IdentityEntitlementDetails
|
||||
pagination_label: IdentityEntitlementDetails
|
||||
sidebar_label: IdentityEntitlementDetails
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetails', 'V2024IdentityEntitlementDetails']
|
||||
slug: /tools/sdk/powershell/v2024/models/identity-entitlement-details
|
||||
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2024IdentityEntitlementDetails']
|
||||
---
|
||||
|
||||
|
||||
# IdentityEntitlementDetails
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityId** | **String** | Id of Identity | [optional]
|
||||
**Entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional]
|
||||
**SourceId** | **String** | Id of Source | [optional]
|
||||
**AccountTargets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$IdentityEntitlementDetails = Initialize-V2024IdentityEntitlementDetails -IdentityId 5928c61f-3f2e-417a-8d65-f76451e2050a `
|
||||
-Entitlement null `
|
||||
-SourceId b56728da-a24d-4177-a207-2bc4d42cba27 `
|
||||
-AccountTargets [{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$IdentityEntitlementDetails | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
id: v2024-identity-entitlement-details-account-target
|
||||
title: IdentityEntitlementDetailsAccountTarget
|
||||
pagination_label: IdentityEntitlementDetailsAccountTarget
|
||||
sidebar_label: IdentityEntitlementDetailsAccountTarget
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2024IdentityEntitlementDetailsAccountTarget']
|
||||
slug: /tools/sdk/powershell/v2024/models/identity-entitlement-details-account-target
|
||||
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2024IdentityEntitlementDetailsAccountTarget']
|
||||
---
|
||||
|
||||
|
||||
# IdentityEntitlementDetailsAccountTarget
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountId** | **String** | The id of account | [optional]
|
||||
**AccountName** | **String** | The name of account | [optional]
|
||||
**AccountUUID** | **String** | The UUID representation of the account if available | [optional]
|
||||
**SourceId** | **String** | The id of Source | [optional]
|
||||
**SourceName** | **String** | The name of Source | [optional]
|
||||
**RemoveDate** | **String** | The removal date scheduled for the entitlement on the Identity | [optional]
|
||||
**AssignmentId** | **String** | The assignmentId of the entitlement on the Identity | [optional]
|
||||
**Revocable** | **Boolean** | If the entitlement can be revoked | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$IdentityEntitlementDetailsAccountTarget = Initialize-V2024IdentityEntitlementDetailsAccountTarget -AccountId c5ef070e-92c6-4276-a006-98490f132dec `
|
||||
-AccountName Adalberto.XYZ `
|
||||
-AccountUUID 2236c29e-68a6-494d-a469-d072172f46cf `
|
||||
-SourceId 9269d764-8358-4ab9-9748-d4b7418548ca `
|
||||
-SourceName JDBC XYZ Source `
|
||||
-RemoveDate 2035-01-01T12:00:00.000Z `
|
||||
-AssignmentId 77a5b7b4-262f-4b6a-a2aa-87f84f45f96f `
|
||||
-Revocable true
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$IdentityEntitlementDetailsAccountTarget | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: v2024-identity-entitlement-details-entitlement-dto
|
||||
title: IdentityEntitlementDetailsEntitlementDto
|
||||
pagination_label: IdentityEntitlementDetailsEntitlementDto
|
||||
sidebar_label: IdentityEntitlementDetailsEntitlementDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2024IdentityEntitlementDetailsEntitlementDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/identity-entitlement-details-entitlement-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2024IdentityEntitlementDetailsEntitlementDto']
|
||||
---
|
||||
|
||||
|
||||
# IdentityEntitlementDetailsEntitlementDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The entitlement id | [optional]
|
||||
**Name** | **String** | The entitlement name | [optional]
|
||||
**Created** | **System.DateTime** | Time when the entitlement was last modified | [optional]
|
||||
**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional]
|
||||
**Description** | **String** | The description of the entitlement | [optional]
|
||||
**Type** | **String** | The type of the object, will always be ""ENTITLEMENT"" | [optional]
|
||||
**SourceId** | **String** | The source ID | [optional]
|
||||
**SourceName** | **String** | The source name | [optional]
|
||||
**Owner** | [**OwnerDto**](owner-dto) | | [optional]
|
||||
**Value** | **String** | The value of the entitlement | [optional]
|
||||
**Flags** | **[]String** | a list of properties informing the viewer about the entitlement | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$IdentityEntitlementDetailsEntitlementDto = Initialize-V2024IdentityEntitlementDetailsEntitlementDto -Id 2c91808874ff91550175097daaec161c `
|
||||
-Name LauncherTest2 `
|
||||
-Created 2020-10-08T18:33:52.029Z `
|
||||
-Modified 2020-10-08T18:33:52.029Z `
|
||||
-Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
|
||||
-Type ENTITLEMENT `
|
||||
-SourceId 2c9180827ca885d7017ca8ce28a000eb `
|
||||
-SourceName ODS-AD-Source `
|
||||
-Owner null `
|
||||
-Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
|
||||
-Flags [privileged]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$IdentityEntitlementDetailsEntitlementDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-identity-entitlements
|
||||
title: IdentityEntitlements
|
||||
pagination_label: IdentityEntitlements
|
||||
sidebar_label: IdentityEntitlements
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlements', 'V2024IdentityEntitlements']
|
||||
slug: /tools/sdk/powershell/v2024/models/identity-entitlements
|
||||
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlements', 'V2024IdentityEntitlements']
|
||||
---
|
||||
|
||||
|
||||
# IdentityEntitlements
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ObjectRef** | [**TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | **[]String** | Labels to be applied to object. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$IdentityEntitlements = Initialize-V2024IdentityEntitlements -ObjectRef null `
|
||||
-Tags [BU_FINANCE, PCI]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$IdentityEntitlements | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
53
docs/tools/sdk/powershell/Reference/V2024/Models/Launcher.md
Normal file
53
docs/tools/sdk/powershell/Reference/V2024/Models/Launcher.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: v2024-launcher
|
||||
title: Launcher
|
||||
pagination_label: Launcher
|
||||
sidebar_label: Launcher
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Launcher', 'V2024Launcher']
|
||||
slug: /tools/sdk/powershell/v2024/models/launcher
|
||||
tags: ['SDK', 'Software Development Kit', 'Launcher', 'V2024Launcher']
|
||||
---
|
||||
|
||||
|
||||
# Launcher
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the Launcher | [required]
|
||||
**Created** | **System.DateTime** | Date the Launcher was created | [required]
|
||||
**Modified** | **System.DateTime** | Date the Launcher was last modified | [required]
|
||||
**Owner** | [**LauncherOwner**](launcher-owner) | | [required]
|
||||
**Name** | **String** | Name of the Launcher, limited to 255 characters | [required]
|
||||
**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required]
|
||||
**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required]
|
||||
**Disabled** | **Boolean** | State of the Launcher | [required]
|
||||
**Reference** | [**LauncherReference**](launcher-reference) | | [optional]
|
||||
**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Launcher = Initialize-V2024Launcher -Id 1b630bed-0941-4792-a712-57a5868ca34d `
|
||||
-Created 2024-04-16T20:07:30.601016489Z `
|
||||
-Modified 2024-04-17T18:02:07.320143194Z `
|
||||
-Owner null `
|
||||
-Name Group Create `
|
||||
-Description Create a new Active Directory Group `
|
||||
-Type INTERACTIVE_PROCESS `
|
||||
-Disabled false `
|
||||
-Reference null `
|
||||
-Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Launcher | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-launcher-owner
|
||||
title: LauncherOwner
|
||||
pagination_label: LauncherOwner
|
||||
sidebar_label: LauncherOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherOwner', 'V2024LauncherOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/launcher-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'V2024LauncherOwner']
|
||||
---
|
||||
|
||||
|
||||
# LauncherOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | Owner type | [required]
|
||||
**Id** | **String** | Owner ID | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherOwner = Initialize-V2024LauncherOwner -Type IDENTITY `
|
||||
-Id 123180847373330f0173c7e1756b6890
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-launcher-reference
|
||||
title: LauncherReference
|
||||
pagination_label: LauncherReference
|
||||
sidebar_label: LauncherReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherReference', 'V2024LauncherReference']
|
||||
slug: /tools/sdk/powershell/v2024/models/launcher-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'V2024LauncherReference']
|
||||
---
|
||||
|
||||
|
||||
# LauncherReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [optional]
|
||||
**Id** | **String** | ID of Launcher reference | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherReference = Initialize-V2024LauncherReference -Type WORKFLOW `
|
||||
-Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherReference | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-launcher-request
|
||||
title: LauncherRequest
|
||||
pagination_label: LauncherRequest
|
||||
sidebar_label: LauncherRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequest', 'V2024LauncherRequest']
|
||||
slug: /tools/sdk/powershell/v2024/models/launcher-request
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'V2024LauncherRequest']
|
||||
---
|
||||
|
||||
|
||||
# LauncherRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the Launcher, limited to 255 characters | [required]
|
||||
**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required]
|
||||
**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required]
|
||||
**Disabled** | **Boolean** | State of the Launcher | [required]
|
||||
**Reference** | [**LauncherRequestReference**](launcher-request-reference) | | [optional]
|
||||
**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherRequest = Initialize-V2024LauncherRequest -Name Group Create `
|
||||
-Description Create a new Active Directory Group `
|
||||
-Type INTERACTIVE_PROCESS `
|
||||
-Disabled false `
|
||||
-Reference null `
|
||||
-Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-launcher-request-reference
|
||||
title: LauncherRequestReference
|
||||
pagination_label: LauncherRequestReference
|
||||
sidebar_label: LauncherRequestReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequestReference', 'V2024LauncherRequestReference']
|
||||
slug: /tools/sdk/powershell/v2024/models/launcher-request-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'V2024LauncherRequestReference']
|
||||
---
|
||||
|
||||
|
||||
# LauncherRequestReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [required]
|
||||
**Id** | **String** | ID of Launcher reference | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherRequestReference = Initialize-V2024LauncherRequestReference -Type WORKFLOW `
|
||||
-Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherRequestReference | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-start-launcher200-response
|
||||
title: StartLauncher200Response
|
||||
pagination_label: StartLauncher200Response
|
||||
sidebar_label: StartLauncher200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'StartLauncher200Response', 'V2024StartLauncher200Response']
|
||||
slug: /tools/sdk/powershell/v2024/models/start-launcher200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'V2024StartLauncher200Response']
|
||||
---
|
||||
|
||||
|
||||
# StartLauncher200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**InteractiveProcessId** | **String** | ID of the Interactive Process that was launched | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$StartLauncher200Response = Initialize-V2024StartLauncher200Response -InteractiveProcessId 5da68cfe-2d60-4b09-858f-0d03acd2f47a
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$StartLauncher200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
43
docs/tools/sdk/powershell/Reference/V2024/Models/Tag.md
Normal file
43
docs/tools/sdk/powershell/Reference/V2024/Models/Tag.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-tag
|
||||
title: Tag
|
||||
pagination_label: Tag
|
||||
sidebar_label: Tag
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Tag', 'V2024Tag']
|
||||
slug: /tools/sdk/powershell/v2024/models/tag
|
||||
tags: ['SDK', 'Software Development Kit', 'Tag', 'V2024Tag']
|
||||
---
|
||||
|
||||
|
||||
# Tag
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Tag id | [required][readonly]
|
||||
**Name** | **String** | Name of the tag. | [required]
|
||||
**Created** | **System.DateTime** | Date the tag was created. | [required][readonly]
|
||||
**Modified** | **System.DateTime** | Date the tag was last modified. | [required][readonly]
|
||||
**TagCategoryRefs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Tag = Initialize-V2024Tag -Id 449ecdc0-d4ff-4341-acf6-92f6f7ce604f `
|
||||
-Name PCI `
|
||||
-Created 2022-05-04T14:48:49Z `
|
||||
-Modified 2022-07-14T16:31:11Z `
|
||||
-TagCategoryRefs null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Tag | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-tag-tag-category-refs-inner
|
||||
title: TagTagCategoryRefsInner
|
||||
pagination_label: TagTagCategoryRefsInner
|
||||
sidebar_label: TagTagCategoryRefsInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'TagTagCategoryRefsInner', 'V2024TagTagCategoryRefsInner']
|
||||
slug: /tools/sdk/powershell/v2024/models/tag-tag-category-refs-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'V2024TagTagCategoryRefsInner']
|
||||
---
|
||||
|
||||
|
||||
# TagTagCategoryRefsInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type of the tagged object's category. | [optional]
|
||||
**Id** | **String** | Tagged object's ID. | [optional]
|
||||
**Name** | **String** | Tagged object's display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$TagTagCategoryRefsInner = Initialize-V2024TagTagCategoryRefsInner -Type ENTITLEMENT `
|
||||
-Id 2c91809773dee32014e13e122092014e `
|
||||
-Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$TagTagCategoryRefsInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -730,6 +730,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## load-account-selections
|
||||
:::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.
|
||||
:::
|
||||
Use this API to fetch account information for an identity against the items in an access request.
|
||||
|
||||
Used to fetch accountSelection for the AccessRequest prior to submitting for async processing.
|
||||
@@ -740,6 +743,7 @@ Used to fetch accountSelection for the AccessRequest prior to submitting for asy
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -761,6 +765,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$AccountsSelectionRequest = @"{
|
||||
"requestedFor" : "2c918084660f45d6016617daa9210584",
|
||||
"clientMetadata" : {
|
||||
@@ -830,10 +835,10 @@ $AccountsSelectionRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest
|
||||
Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
Invoke-V2025LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
# Invoke-V2025LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -501,6 +501,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-identities-invite
|
||||
:::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.
|
||||
:::
|
||||
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
|
||||
|
||||
This task will send an invitation email only for unregistered identities.
|
||||
@@ -513,6 +516,7 @@ The executed task status can be checked by Task Management > [Get task status by
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -535,6 +539,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$InviteIdentitiesRequest = @"{
|
||||
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
|
||||
"uninvited" : false
|
||||
@@ -544,10 +549,10 @@ $InviteIdentitiesRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
|
||||
Start-V2025IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2025IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
# Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -287,9 +287,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## generate-identity-preview
|
||||
:::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.
|
||||
:::
|
||||
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/generate-identity-preview)
|
||||
@@ -297,7 +294,6 @@ This generates a non-persisted IdentityDetails object that will represent as the
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
|
||||
|
||||
### Return type
|
||||
@@ -319,7 +315,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentityPreviewRequest = @"{
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
"identityAttributeConfig" : {
|
||||
@@ -352,10 +347,10 @@ $IdentityPreviewRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
|
||||
New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
New-V2025IdentityPreview -IdentityPreviewRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
# New-V2025IdentityPreview -IdentityPreviewRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -0,0 +1,330 @@
|
||||
---
|
||||
id: v2025-launchers
|
||||
title: Launchers
|
||||
pagination_label: Launchers
|
||||
sidebar_label: Launchers
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Launchers', 'V2025Launchers']
|
||||
slug: /tools/sdk/powershell/v2025/methods/launchers
|
||||
tags: ['SDK', 'Software Development Kit', 'Launchers', 'V2025Launchers']
|
||||
---
|
||||
|
||||
# Launchers
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2025Launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
|
||||
[**Remove-V2025Launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
|
||||
[**Get-V2025Launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
|
||||
[**Get-V2025Launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
|
||||
[**Send-V2025Launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
|
||||
[**Start-V2025Launcher**](#start-launcher) | **POST** `/launchers/{launcherID}/launch` | Launch a launcher
|
||||
|
||||
|
||||
## create-launcher
|
||||
Create a Launcher with given information
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-launcher)
|
||||
|
||||
### Parameters
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
201 | Launcher created successfully | Launcher
|
||||
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
|
||||
$LauncherRequest = @"{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}"@
|
||||
|
||||
# Create launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
New-V2025Launcher -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025Launcher -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-launcher
|
||||
Delete the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-launcher)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | LauncherID | **String** | True | ID of the Launcher to be deleted
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | Launcher deleted successfully |
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
|
||||
|
||||
# Delete launcher
|
||||
|
||||
try {
|
||||
Remove-V2025Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-launcher
|
||||
Get details for the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-launcher)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | LauncherID | **String** | True | ID of the Launcher to be retrieved
|
||||
|
||||
### Return type
|
||||
[**Launcher**](../models/launcher)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Launcher retrieved successfully | Launcher
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
|
||||
|
||||
# Get launcher by id
|
||||
|
||||
try {
|
||||
Get-V2025Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Launcher"
|
||||
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/v2025/get-launchers)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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: **description**: *sw* **disabled**: *eq* **name**: *sw*
|
||||
Query | Next | **String** | (optional) | Pagination marker
|
||||
Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return
|
||||
|
||||
### Return type
|
||||
[**GetLaunchers200Response**](../models/get-launchers200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of Launchers | GetLaunchers200Response
|
||||
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
|
||||
$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-V2025Launchers
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Launchers -Filters $Filters -Next $Next -Limit $Limit
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Launchers"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-launcher
|
||||
Replace the given Launcher ID with given payload
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-launcher)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Launcher replaced successfully | Launcher
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced
|
||||
$LauncherRequest = @"{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}"@
|
||||
|
||||
# Replace launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
Send-V2025Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2025Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-launcher
|
||||
Launch the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-launcher)
|
||||
|
||||
### Parameters
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Launcher launched successfully | StartLauncher200Response
|
||||
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
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
|
||||
|
||||
# Launch a launcher
|
||||
|
||||
try {
|
||||
Start-V2025Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2025Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -33,6 +33,9 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## create-password-policy
|
||||
:::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.
|
||||
:::
|
||||
This API creates the specified password policy.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-policy)
|
||||
@@ -40,6 +43,7 @@ This API creates the specified password policy.
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
|
||||
|
||||
### Return type
|
||||
@@ -62,6 +66,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$PasswordPolicyV3Dto = @"{
|
||||
"validateAgainstAccountName" : true,
|
||||
"minLength" : 8,
|
||||
@@ -100,10 +105,10 @@ $PasswordPolicyV3Dto = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
|
||||
New-V2025PasswordPolicy -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
|
||||
# New-V2025PasswordPolicy -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -112,6 +117,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-password-policy
|
||||
:::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.
|
||||
:::
|
||||
This API deletes the specified password policy.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-policy)
|
||||
@@ -120,6 +128,7 @@ This API deletes the specified password policy.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of password policy to delete.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
@@ -142,14 +151,15 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Delete password policy by id
|
||||
|
||||
try {
|
||||
Remove-V2025PasswordPolicy -Id $Id
|
||||
Remove-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025PasswordPolicy -Id $Id
|
||||
# Remove-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -158,6 +168,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-password-policy-by-id
|
||||
:::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.
|
||||
:::
|
||||
This API returns the password policy for the specified ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-policy-by-id)
|
||||
@@ -166,6 +179,7 @@ This API returns the password policy for the specified ID.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of password policy to retrieve.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
|
||||
@@ -188,14 +202,15 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Get password policy by id
|
||||
|
||||
try {
|
||||
Get-V2025PasswordPolicyById -Id $Id
|
||||
Get-V2025PasswordPolicyById -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordPolicyById -Id $Id
|
||||
# Get-V2025PasswordPolicyById -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -204,6 +219,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-password-policies
|
||||
:::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.
|
||||
:::
|
||||
This gets list of all Password Policies.
|
||||
Requires role of ORG_ADMIN
|
||||
|
||||
@@ -212,6 +230,7 @@ Requires role of ORG_ADMIN
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
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.
|
||||
@@ -235,6 +254,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$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)
|
||||
@@ -242,10 +262,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
# List password policies
|
||||
|
||||
try {
|
||||
Get-V2025PasswordPolicies
|
||||
Get-V2025PasswordPolicies -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
|
||||
# Get-V2025PasswordPolicies -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -254,6 +274,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-password-policy
|
||||
:::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.
|
||||
:::
|
||||
This API updates the specified password policy.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-password-policy)
|
||||
@@ -262,6 +285,7 @@ This API updates the specified password policy.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of password policy to update.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
|
||||
|
||||
### Return type
|
||||
@@ -285,6 +309,7 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$PasswordPolicyV3Dto = @"{
|
||||
"validateAgainstAccountName" : true,
|
||||
"minLength" : 8,
|
||||
@@ -323,10 +348,10 @@ $PasswordPolicyV3Dto = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
|
||||
Set-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
|
||||
# Set-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -0,0 +1,237 @@
|
||||
---
|
||||
id: v2025-tags
|
||||
title: Tags
|
||||
pagination_label: Tags
|
||||
sidebar_label: Tags
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Tags', 'V2025Tags']
|
||||
slug: /tools/sdk/powershell/v2025/methods/tags
|
||||
tags: ['SDK', 'Software Development Kit', 'Tags', 'V2025Tags']
|
||||
---
|
||||
|
||||
# Tags
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2025Tag**](#create-tag) | **POST** `/tags` | Create tag
|
||||
[**Remove-V2025TagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
|
||||
[**Get-V2025TagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
|
||||
[**Get-V2025Tags**](#list-tags) | **GET** `/tags` | List tags
|
||||
|
||||
|
||||
## create-tag
|
||||
This API creates new tag.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-tag)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | Tag | [**Tag**](../models/tag) | True |
|
||||
|
||||
### Return type
|
||||
[**Tag**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
201 | Created tag. | Tag
|
||||
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
|
||||
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
|
||||
$Tag = @"{
|
||||
"created" : "2022-05-04T14:48:49Z",
|
||||
"tagCategoryRefs" : [ {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
}, {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
} ],
|
||||
"name" : "PCI",
|
||||
"modified" : "2022-07-14T16:31:11Z",
|
||||
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
|
||||
}"@
|
||||
|
||||
# Create tag
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToTag -Json $Tag
|
||||
New-V2025Tag -Tag $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025Tag -Tag $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Tag"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-tag-by-id
|
||||
This API deletes a tag by specified id.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tag-by-id)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of the object reference to delete.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | No content. |
|
||||
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
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
|
||||
|
||||
# Delete tag
|
||||
|
||||
try {
|
||||
Remove-V2025TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-tag-by-id
|
||||
Returns a tag by its id.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tag-by-id)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of the object reference to retrieve.
|
||||
|
||||
### Return type
|
||||
[**Tag**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Tag | Tag
|
||||
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
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
|
||||
|
||||
# Get tag by id
|
||||
|
||||
try {
|
||||
Get-V2025TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-tags
|
||||
This API returns a list of tags.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-tags)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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: **id**: *eq, in* **name**: *eq, in, sw*
|
||||
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, created, modified**
|
||||
|
||||
### Return type
|
||||
[**Tag[]**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of all tags. | Tag[]
|
||||
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
|
||||
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
|
||||
$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 = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # 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: **id**: *eq, in* **name**: *eq, in, sw* (optional)
|
||||
$Sorters = "name,-modified" # 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, created, modified** (optional)
|
||||
|
||||
# List tags
|
||||
|
||||
try {
|
||||
Get-V2025Tags
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Tags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tags"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-get-launchers200-response
|
||||
title: GetLaunchers200Response
|
||||
pagination_label: GetLaunchers200Response
|
||||
sidebar_label: GetLaunchers200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'GetLaunchers200Response', 'V2025GetLaunchers200Response']
|
||||
slug: /tools/sdk/powershell/v2025/models/get-launchers200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'V2025GetLaunchers200Response']
|
||||
---
|
||||
|
||||
|
||||
# GetLaunchers200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Next** | **String** | Pagination marker | [optional]
|
||||
**Items** | [**[]Launcher**](launcher) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$GetLaunchers200Response = Initialize-V2025GetLaunchers200Response -Next null `
|
||||
-Items null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$GetLaunchers200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
53
docs/tools/sdk/powershell/Reference/V2025/Models/Launcher.md
Normal file
53
docs/tools/sdk/powershell/Reference/V2025/Models/Launcher.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: v2025-launcher
|
||||
title: Launcher
|
||||
pagination_label: Launcher
|
||||
sidebar_label: Launcher
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Launcher', 'V2025Launcher']
|
||||
slug: /tools/sdk/powershell/v2025/models/launcher
|
||||
tags: ['SDK', 'Software Development Kit', 'Launcher', 'V2025Launcher']
|
||||
---
|
||||
|
||||
|
||||
# Launcher
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the Launcher | [required]
|
||||
**Created** | **System.DateTime** | Date the Launcher was created | [required]
|
||||
**Modified** | **System.DateTime** | Date the Launcher was last modified | [required]
|
||||
**Owner** | [**LauncherOwner**](launcher-owner) | | [required]
|
||||
**Name** | **String** | Name of the Launcher, limited to 255 characters | [required]
|
||||
**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required]
|
||||
**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required]
|
||||
**Disabled** | **Boolean** | State of the Launcher | [required]
|
||||
**Reference** | [**LauncherReference**](launcher-reference) | | [optional]
|
||||
**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Launcher = Initialize-V2025Launcher -Id 1b630bed-0941-4792-a712-57a5868ca34d `
|
||||
-Created 2024-04-16T20:07:30.601016489Z `
|
||||
-Modified 2024-04-17T18:02:07.320143194Z `
|
||||
-Owner null `
|
||||
-Name Group Create `
|
||||
-Description Create a new Active Directory Group `
|
||||
-Type INTERACTIVE_PROCESS `
|
||||
-Disabled false `
|
||||
-Reference null `
|
||||
-Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Launcher | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-launcher-owner
|
||||
title: LauncherOwner
|
||||
pagination_label: LauncherOwner
|
||||
sidebar_label: LauncherOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherOwner', 'V2025LauncherOwner']
|
||||
slug: /tools/sdk/powershell/v2025/models/launcher-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'V2025LauncherOwner']
|
||||
---
|
||||
|
||||
|
||||
# LauncherOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | Owner type | [required]
|
||||
**Id** | **String** | Owner ID | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherOwner = Initialize-V2025LauncherOwner -Type IDENTITY `
|
||||
-Id 123180847373330f0173c7e1756b6890
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-launcher-reference
|
||||
title: LauncherReference
|
||||
pagination_label: LauncherReference
|
||||
sidebar_label: LauncherReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherReference', 'V2025LauncherReference']
|
||||
slug: /tools/sdk/powershell/v2025/models/launcher-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'V2025LauncherReference']
|
||||
---
|
||||
|
||||
|
||||
# LauncherReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [optional]
|
||||
**Id** | **String** | ID of Launcher reference | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherReference = Initialize-V2025LauncherReference -Type WORKFLOW `
|
||||
-Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherReference | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2025-launcher-request
|
||||
title: LauncherRequest
|
||||
pagination_label: LauncherRequest
|
||||
sidebar_label: LauncherRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequest', 'V2025LauncherRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/launcher-request
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'V2025LauncherRequest']
|
||||
---
|
||||
|
||||
|
||||
# LauncherRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the Launcher, limited to 255 characters | [required]
|
||||
**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required]
|
||||
**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required]
|
||||
**Disabled** | **Boolean** | State of the Launcher | [required]
|
||||
**Reference** | [**LauncherRequestReference**](launcher-request-reference) | | [optional]
|
||||
**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherRequest = Initialize-V2025LauncherRequest -Name Group Create `
|
||||
-Description Create a new Active Directory Group `
|
||||
-Type INTERACTIVE_PROCESS `
|
||||
-Disabled false `
|
||||
-Reference null `
|
||||
-Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-launcher-request-reference
|
||||
title: LauncherRequestReference
|
||||
pagination_label: LauncherRequestReference
|
||||
sidebar_label: LauncherRequestReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequestReference', 'V2025LauncherRequestReference']
|
||||
slug: /tools/sdk/powershell/v2025/models/launcher-request-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'V2025LauncherRequestReference']
|
||||
---
|
||||
|
||||
|
||||
# LauncherRequestReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [required]
|
||||
**Id** | **String** | ID of Launcher reference | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$LauncherRequestReference = Initialize-V2025LauncherRequestReference -Type WORKFLOW `
|
||||
-Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$LauncherRequestReference | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2025-start-launcher200-response
|
||||
title: StartLauncher200Response
|
||||
pagination_label: StartLauncher200Response
|
||||
sidebar_label: StartLauncher200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'StartLauncher200Response', 'V2025StartLauncher200Response']
|
||||
slug: /tools/sdk/powershell/v2025/models/start-launcher200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'V2025StartLauncher200Response']
|
||||
---
|
||||
|
||||
|
||||
# StartLauncher200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**InteractiveProcessId** | **String** | ID of the Interactive Process that was launched | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$StartLauncher200Response = Initialize-V2025StartLauncher200Response -InteractiveProcessId 5da68cfe-2d60-4b09-858f-0d03acd2f47a
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$StartLauncher200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
43
docs/tools/sdk/powershell/Reference/V2025/Models/Tag.md
Normal file
43
docs/tools/sdk/powershell/Reference/V2025/Models/Tag.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2025-tag
|
||||
title: Tag
|
||||
pagination_label: Tag
|
||||
sidebar_label: Tag
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Tag', 'V2025Tag']
|
||||
slug: /tools/sdk/powershell/v2025/models/tag
|
||||
tags: ['SDK', 'Software Development Kit', 'Tag', 'V2025Tag']
|
||||
---
|
||||
|
||||
|
||||
# Tag
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Tag id | [required][readonly]
|
||||
**Name** | **String** | Name of the tag. | [required]
|
||||
**Created** | **System.DateTime** | Date the tag was created. | [required][readonly]
|
||||
**Modified** | **System.DateTime** | Date the tag was last modified. | [required][readonly]
|
||||
**TagCategoryRefs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Tag = Initialize-V2025Tag -Id 449ecdc0-d4ff-4341-acf6-92f6f7ce604f `
|
||||
-Name PCI `
|
||||
-Created 2022-05-04T14:48:49Z `
|
||||
-Modified 2022-07-14T16:31:11Z `
|
||||
-TagCategoryRefs null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Tag | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-tag-tag-category-refs-inner
|
||||
title: TagTagCategoryRefsInner
|
||||
pagination_label: TagTagCategoryRefsInner
|
||||
sidebar_label: TagTagCategoryRefsInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'TagTagCategoryRefsInner', 'V2025TagTagCategoryRefsInner']
|
||||
slug: /tools/sdk/powershell/v2025/models/tag-tag-category-refs-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'V2025TagTagCategoryRefsInner']
|
||||
---
|
||||
|
||||
|
||||
# TagTagCategoryRefsInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type of the tagged object's category. | [optional]
|
||||
**Id** | **String** | Tagged object's ID. | [optional]
|
||||
**Name** | **String** | Tagged object's display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$TagTagCategoryRefsInner = Initialize-V2025TagTagCategoryRefsInner -Type ENTITLEMENT `
|
||||
-Id 2c91809773dee32014e13e122092014e `
|
||||
-Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$TagTagCategoryRefsInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -839,6 +839,27 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /revocable-objects
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#get-entitlement-details-for-identity
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID.
|
||||
$EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID
|
||||
|
||||
# Identity entitlement details
|
||||
|
||||
try {
|
||||
Get-V2024EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDetailsForIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /access-request-status
|
||||
method: GET
|
||||
xCodeSample:
|
||||
@@ -902,6 +923,7 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#load-account-selections
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$AccountsSelectionRequest = @"
|
||||
{
|
||||
"requestedFor" : "2c918084660f45d6016617daa9210584",
|
||||
@@ -973,10 +995,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest
|
||||
Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
Invoke-V2024LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
# Invoke-V2024LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -7689,6 +7711,28 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /entitlements/identities/{id}/entitlements
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/identities#list-entitlements-by-identity
|
||||
source: |
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity 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)
|
||||
|
||||
# List of entitlements by identity.
|
||||
|
||||
try {
|
||||
Get-V2024EntitlementsByIdentity -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024EntitlementsByIdentity -Id $Id -Limit $Limit -Offset $Offset -Count $Count
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsByIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /identities
|
||||
method: GET
|
||||
xCodeSample:
|
||||
@@ -7765,6 +7809,7 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identities-invite
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$InviteIdentitiesRequest = @"
|
||||
{
|
||||
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
|
||||
@@ -7776,10 +7821,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
|
||||
Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
# Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -8407,7 +8452,6 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#generate-identity-preview
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentityPreviewRequest = @"
|
||||
{
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
@@ -8442,10 +8486,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
|
||||
New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
New-V2024IdentityPreview -IdentityPreviewRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
# New-V2024IdentityPreview -IdentityPreviewRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -8638,6 +8682,149 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/launchers#create-launcher
|
||||
source: |
|
||||
$LauncherRequest = @"
|
||||
{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}
|
||||
"@
|
||||
|
||||
# Create launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
New-V2024Launcher -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024Launcher -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}
|
||||
method: DELETE
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/launchers#delete-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
|
||||
|
||||
# Delete launcher
|
||||
|
||||
try {
|
||||
Remove-V2024Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/launchers#get-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
|
||||
|
||||
# Get launcher by id
|
||||
|
||||
try {
|
||||
Get-V2024Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/launchers#get-launchers
|
||||
source: |
|
||||
$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-V2024Launchers
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Launchers -Filters $Filters -Next $Next -Limit $Limit
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Launchers"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}
|
||||
method: PUT
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/launchers#put-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced
|
||||
$LauncherRequest = @"
|
||||
{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}
|
||||
"@
|
||||
|
||||
# Replace launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
Send-V2024Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2024Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}/launch
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/launchers#start-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
|
||||
|
||||
# Launch a launcher
|
||||
|
||||
try {
|
||||
Start-V2024Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2024Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /identity-profiles/{identity-profile-id}/lifecycle-states
|
||||
method: POST
|
||||
xCodeSample:
|
||||
@@ -17245,6 +17432,103 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/tags#create-tag
|
||||
source: |
|
||||
$Tag = @"
|
||||
{
|
||||
"created" : "2022-05-04T14:48:49Z",
|
||||
"tagCategoryRefs" : [ {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
}, {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
} ],
|
||||
"name" : "PCI",
|
||||
"modified" : "2022-07-14T16:31:11Z",
|
||||
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
|
||||
}
|
||||
"@
|
||||
|
||||
# Create tag
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToTag -Json $Tag
|
||||
New-V2024Tag -Tag $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024Tag -Tag $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Tag"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags/{id}
|
||||
method: DELETE
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/tags#delete-tag-by-id
|
||||
source: |
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
|
||||
|
||||
# Delete tag
|
||||
|
||||
try {
|
||||
Remove-V2024TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags/{id}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/tags#get-tag-by-id
|
||||
source: |
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
|
||||
|
||||
# Get tag by id
|
||||
|
||||
try {
|
||||
Get-V2024TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2024/methods/tags#list-tags
|
||||
source: |
|
||||
$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 = "id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # 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: **id**: *eq, in* **name**: *eq, in, sw* (optional)
|
||||
$Sorters = "name,-modified" # 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, created, modified** (optional)
|
||||
|
||||
# List tags
|
||||
|
||||
try {
|
||||
Get-V2024Tags
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Tags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tags"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /task-status/pending-tasks
|
||||
method: HEAD
|
||||
xCodeSample:
|
||||
|
||||
@@ -1129,6 +1129,7 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/access-requests#load-account-selections
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$AccountsSelectionRequest = @"
|
||||
{
|
||||
"requestedFor" : "2c918084660f45d6016617daa9210584",
|
||||
@@ -1200,10 +1201,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest
|
||||
Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
Invoke-V2025LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result
|
||||
# Invoke-V2025LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -8390,6 +8391,7 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identities-invite
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$InviteIdentitiesRequest = @"
|
||||
{
|
||||
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
|
||||
@@ -8401,10 +8403,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
|
||||
Start-V2025IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2025IdentitiesInvite -InviteIdentitiesRequest $Result
|
||||
# Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -9032,7 +9034,6 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#generate-identity-preview
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentityPreviewRequest = @"
|
||||
{
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
@@ -9067,10 +9068,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
|
||||
New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
New-V2025IdentityPreview -IdentityPreviewRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
|
||||
# New-V2025IdentityPreview -IdentityPreviewRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -9263,6 +9264,149 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025IdentityProfile"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/launchers#create-launcher
|
||||
source: |
|
||||
$LauncherRequest = @"
|
||||
{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}
|
||||
"@
|
||||
|
||||
# Create launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
New-V2025Launcher -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025Launcher -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}
|
||||
method: DELETE
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/launchers#delete-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
|
||||
|
||||
# Delete launcher
|
||||
|
||||
try {
|
||||
Remove-V2025Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/launchers#get-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
|
||||
|
||||
# Get launcher by id
|
||||
|
||||
try {
|
||||
Get-V2025Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/launchers#get-launchers
|
||||
source: |
|
||||
$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-V2025Launchers
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Launchers -Filters $Filters -Next $Next -Limit $Limit
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Launchers"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}
|
||||
method: PUT
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/launchers#put-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced
|
||||
$LauncherRequest = @"
|
||||
{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}
|
||||
"@
|
||||
|
||||
# Replace launcher
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
|
||||
Send-V2025Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2025Launcher -LauncherID $LauncherID -LauncherRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /launchers/{launcherID}/launch
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/launchers#start-launcher
|
||||
source: |
|
||||
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
|
||||
|
||||
# Launch a launcher
|
||||
|
||||
try {
|
||||
Start-V2025Launcher -LauncherID $LauncherID
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-V2025Launcher -LauncherID $LauncherID
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Launcher"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /identity-profiles/{identity-profile-id}/lifecycle-states
|
||||
method: POST
|
||||
xCodeSample:
|
||||
@@ -12476,6 +12620,7 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/password-policies#create-password-policy
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$PasswordPolicyV3Dto = @"
|
||||
{
|
||||
"validateAgainstAccountName" : true,
|
||||
@@ -12516,10 +12661,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
|
||||
New-V2025PasswordPolicy -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
|
||||
# New-V2025PasswordPolicy -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -12531,14 +12676,15 @@
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/password-policies#delete-password-policy
|
||||
source: |
|
||||
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Delete password policy by id
|
||||
|
||||
try {
|
||||
Remove-V2025PasswordPolicy -Id $Id
|
||||
Remove-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025PasswordPolicy -Id $Id
|
||||
# Remove-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -12550,14 +12696,15 @@
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/password-policies#get-password-policy-by-id
|
||||
source: |
|
||||
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Get password policy by id
|
||||
|
||||
try {
|
||||
Get-V2025PasswordPolicyById -Id $Id
|
||||
Get-V2025PasswordPolicyById -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordPolicyById -Id $Id
|
||||
# Get-V2025PasswordPolicyById -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -12568,6 +12715,7 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/password-policies#list-password-policies
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$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)
|
||||
@@ -12575,10 +12723,10 @@
|
||||
# List password policies
|
||||
|
||||
try {
|
||||
Get-V2025PasswordPolicies
|
||||
Get-V2025PasswordPolicies -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
|
||||
# Get-V2025PasswordPolicies -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -12590,6 +12738,7 @@
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/password-policies#set-password-policy
|
||||
source: |
|
||||
$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$PasswordPolicyV3Dto = @"
|
||||
{
|
||||
"validateAgainstAccountName" : true,
|
||||
@@ -12630,10 +12779,10 @@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
|
||||
Set-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
|
||||
# Set-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -18060,6 +18209,103 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagsToManyObjects"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/tags#create-tag
|
||||
source: |
|
||||
$Tag = @"
|
||||
{
|
||||
"created" : "2022-05-04T14:48:49Z",
|
||||
"tagCategoryRefs" : [ {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
}, {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
} ],
|
||||
"name" : "PCI",
|
||||
"modified" : "2022-07-14T16:31:11Z",
|
||||
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
|
||||
}
|
||||
"@
|
||||
|
||||
# Create tag
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToTag -Json $Tag
|
||||
New-V2025Tag -Tag $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025Tag -Tag $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Tag"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags/{id}
|
||||
method: DELETE
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/tags#delete-tag-by-id
|
||||
source: |
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
|
||||
|
||||
# Delete tag
|
||||
|
||||
try {
|
||||
Remove-V2025TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags/{id}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/tags#get-tag-by-id
|
||||
source: |
|
||||
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
|
||||
|
||||
# Get tag by id
|
||||
|
||||
try {
|
||||
Get-V2025TagById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025TagById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TagById"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /tags
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/tags#list-tags
|
||||
source: |
|
||||
$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 = "id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # 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: **id**: *eq, in* **name**: *eq, in, sw* (optional)
|
||||
$Sorters = "name,-modified" # 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, created, modified** (optional)
|
||||
|
||||
# List tags
|
||||
|
||||
try {
|
||||
Get-V2025Tags
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Tags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tags"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /task-status/pending-tasks
|
||||
method: HEAD
|
||||
xCodeSample:
|
||||
|
||||
Reference in New Issue
Block a user