Update to powershell SDK docs: 13122455471

2025-12-09 20:37:47 +00:00 · 2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
--- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md
+++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md
@@ -1,3 +1,4 @@
+
 ---
 id: v2024-triggers
 title: Triggers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/triggers
 tags: ['SDK', 'Software Development Kit', 'Triggers', 'V2024Triggers']
 ---

-
 # Triggers
  Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions.  These endpoints allow for programatically creating and managing trigger subscriptions.

@@ -70,9 +70,7 @@ Method | HTTP request | Description
 [**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
 [**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription

-
 ## complete-trigger-invocation
-
 Completes an invocation to a REQUEST_RESPONSE type trigger.

 ### Parameters 
@@ -83,7 +81,6 @@ Path   | Id | **String** | True  | The ID of the invocation to complete.
 Body  | CompleteInvocation | [**CompleteInvocation**](../models/complete-invocation) | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -97,7 +94,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -112,7 +108,9 @@ $CompleteInvocation = @"{
  "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
  "error" : "Access request is denied."
 }"@
+
 # Complete Trigger Invocation
+
 try {
    $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
    Complete-V2024TriggerInvocation-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result
@@ -124,11 +122,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## create-subscription
-
 This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:
 * HTTP subscriptions require httpConfig
 * EventBridge subscriptions require eventBridgeConfig
@@ -140,7 +135,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | SubscriptionPostRequest | [**SubscriptionPostRequest**](../models/subscription-post-request) | True  | 

 ### Return type
-
 [**Subscription**](../models/subscription)

 ### Responses
@@ -154,7 +148,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -186,7 +179,9 @@ $SubscriptionPostRequest = @"{
  "type" : "HTTP",
  "enabled" : true
 }"@
+
 # Create a Subscription
+
 try {
    $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
    New-V2024Subscription-V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result
@@ -198,11 +193,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## delete-subscription
-
 Deletes an existing subscription to a trigger.

 ### Parameters 
@@ -212,7 +204,6 @@ Path   | Id | **String** | True  | Subscription ID
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

 ### Return type
-
 (empty response body)

 ### Responses
@@ -227,7 +218,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -235,7 +225,9 @@ Code | Description  | Data Type
 ```powershell
 $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
 # Delete a Subscription
+
 try {
    Remove-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -246,11 +238,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-subscriptions
-
 Gets a list of all trigger subscriptions.

 ### Parameters 
@@ -264,7 +253,6 @@ Param Type | Name | Data Type | Required  | Description
  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: **triggerId, triggerName**

 ### Return type
-
 [**Subscription[]**](../models/subscription)

 ### Responses
@@ -278,7 +266,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -290,7 +277,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $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 "12cff757-c0c0-413b-8ad7-2a47956d1e89"' # 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*  **triggerId**: *eq*  **type**: *eq, le* (optional)
 $Sorters = "triggerName" # 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: **triggerId, triggerName** (optional)
+
 # List Subscriptions
+
 try {
    Get-V2024Subscriptions-V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -301,11 +290,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-trigger-invocation-status
-
 Gets a list of latest invocation statuses.
 Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.
 This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.
@@ -321,7 +307,6 @@ Param Type | Name | Data Type | Required  | Description
  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: **triggerId, subscriptionName, created, completed**

 ### Return type
-
 [**InvocationStatus[]**](../models/invocation-status)

 ### Responses
@@ -335,7 +320,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -347,7 +331,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $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 = 'triggerId eq "idn:access-request-dynamic-approver"' # 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:  **triggerId**: *eq*  **subscriptionId**: *eq* (optional)
 $Sorters = "created" # 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: **triggerId, subscriptionName, created, completed** (optional)
+
 # List Latest Invocation Statuses
+
 try {
    Get-V2024TriggerInvocationStatus-V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -358,11 +344,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-triggers
-
 Gets a list of triggers that are available in the tenant.

 ### Parameters 
@@ -376,7 +359,6 @@ Param Type | Name | Data Type | Required  | Description
  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**

 ### Return type
-
 [**Trigger[]**](../models/trigger)

 ### Responses
@@ -390,7 +372,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -402,7 +383,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $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 "idn:access-request-post-approval"' # 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, ge, le* (optional)
 $Sorters = "name" # 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** (optional)
+
 # List Triggers
+
 try {
    Get-V2024Triggers-V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -413,11 +396,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## patch-subscription
-
 This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:

 **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**
@@ -430,7 +410,6 @@ Path   | Id | **String** | True  | ID of the Subscription to patch
 Body  | SubscriptionPatchRequestInner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True  | 

 ### Return type
-
 [**Subscription**](../models/subscription)

 ### Responses
@@ -445,7 +424,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json-patch+json
 - **Accept**: application/json

@@ -453,10 +431,11 @@ Code | Description  | Data Type
 ```powershell
 $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
- # SubscriptionPatchRequestInner[] | 
- $SubscriptionPatchRequestInner = @""@ 
+ $SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] | 
+ 

 # Patch a Subscription
+
 try {
    $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
    Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result
@@ -468,11 +447,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## start-test-trigger-invocation
-
 Initiate a test event for all subscribers of the specified event trigger.  If there are no subscribers to the specified trigger in the tenant, then no test event will be sent.

 ### Parameters 
@@ -482,7 +458,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | TestInvocation | [**TestInvocation**](../models/test-invocation) | True  | 

 ### Return type
-
 [**Invocation[]**](../models/invocation)

 ### Responses
@@ -497,7 +472,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -514,7 +488,9 @@ $TestInvocation = @"{
    "workflowId" : 1234
  }
 }"@
+
 # Start a Test Invocation
+
 try {
    $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
    Start-V2024TestTriggerInvocation-V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result
@@ -526,11 +502,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## test-subscription-filter
-
 Validates a JSONPath filter expression against a provided mock input.
 Request requires a security scope of: 

@@ -541,7 +514,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | ValidateFilterInputDto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True  | 

 ### Return type
-
 [**ValidateFilterOutputDto**](../models/validate-filter-output-dto)

 ### Responses
@@ -555,7 +527,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -568,7 +539,9 @@ $ValidateFilterInputDto = @"{
    "identityId" : "201327fda1c44704ac01181e963d463c"
  }
 }"@
+
 # Validate a Subscription Filter
+
 try {
    $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
    Test-V2024SubscriptionFilter-V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result
@@ -580,11 +553,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## update-subscription
-
 This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing
  Subscription is completely replaced. The following fields are immutable:

@@ -604,7 +574,6 @@ Path   | Id | **String** | True  | Subscription ID
 Body  | SubscriptionPutRequest | [**SubscriptionPutRequest**](../models/subscription-put-request) | True  | 

 ### Return type
-
 [**Subscription**](../models/subscription)

 ### Responses
@@ -619,7 +588,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -651,7 +619,9 @@ $SubscriptionPutRequest = @"{
  "type" : "HTTP",
  "enabled" : true
 }"@
+
 # Update a Subscription
+
 try {
    $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest
    Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result
@@ -663,7 +633,4 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
-