--- id: v2024-triggers title: Triggers pagination_label: Triggers sidebar_label: Triggers sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'Triggers'] slug: /tools/sdk/powershell/v2024/methods/triggers tags: ['SDK', 'Software Development Kit', 'Triggers'] --- # Triggers All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**Complete-V2024TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation [**New-V2024Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription [**Remove-V2024Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription [**Get-V2024Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions [**Get-V2024TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses [**Get-V2024Triggers**](#list-triggers) | **GET** `/triggers` | List Triggers [**Update-V2024Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription [**Start-V2024TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation [**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 Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the invocation to complete. | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | CompleteInvocation | [**CompleteInvocation**](../models/complete-invocation) | True | ### Return type (empty response body) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 204 | No content - indicates the request was successful but there is no content to be returned in the response. | 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 $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CompleteInvocation = @"{ "output" : { "approved" : false }, "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 # Below is a request that includes all optional parameters # Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $CompleteInvocation } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" 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 ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SubscriptionPostRequest | [**SubscriptionPostRequest**](../models/subscription-post-request) | True | ### Return type [**Subscription**](../models/subscription) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 201 | New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. | Subscription 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 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SubscriptionPostRequest = @"{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { "bearerToken" : "bearerToken" }, "httpAuthenticationType" : "BASIC_AUTH", "httpDispatchMode" : "SYNC", "basicAuthConfig" : { "password" : "password", "userName" : "user@example.com" }, "url" : "https://www.example.com" }, "triggerId" : "idn:access-requested", "name" : "Access request subscription", "description" : "Access requested to site xyz", "eventBridgeConfig" : { "awsRegion" : "us-west-1", "awsAccount" : "123456789012" }, "responseDeadline" : "PT1H", "type" : "HTTP", "enabled" : true }"@ # Create a Subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest New-V2024Subscription-V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result # Below is a request that includes all optional parameters # New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $SubscriptionPostRequest } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## delete-subscription Deletes an existing subscription to a trigger. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- 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 Code | Description | Data Type ------------- | ------------- | ------------- 204 | No content - indicates the request was successful but there is no content to be returned in the response. | 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 = "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 # Below is a request that includes all optional parameters # Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## list-subscriptions Gets a list of all trigger subscriptions. ### 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. 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* **triggerId**: *eq* **type**: *eq, le* 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 Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of subscriptions. | Subscription[] 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 $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) $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 # Below is a request that includes all optional parameters # Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" 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. ### 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. 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: **triggerId**: *eq* **subscriptionId**: *eq* 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 Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of latest invocation statuses. | InvocationStatus[] 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 $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) $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 # Below is a request that includes all optional parameters # Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## list-triggers Gets a list of triggers that are available in the tenant. ### 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. 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, ge, le* 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 Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of triggers. | Trigger[] 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 $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) $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 # Below is a request that includes all optional parameters # Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" 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** ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Subscription to patch | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SubscriptionPatchRequestInner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True | ### Return type [**Subscription**](../models/subscription) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Updated subscription. | Subscription 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-patch+json - **Accept**: application/json ### Example ```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 = @""@ # Patch a Subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $SubscriptionPatchRequestInner } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" 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 Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | TestInvocation | [**TestInvocation**](../models/test-invocation) | True | ### Return type [**Invocation[]**](../models/invocation) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Test trigger invocations that have been started for specified subscription(s). | Invocation[] 204 | No content - indicates the request was successful but there is no content to be returned in the response. | 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 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $TestInvocation = @"{ "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" }, "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], "triggerId" : "idn:access-request-post-approval", "contentJson" : { "workflowId" : 1234 } }"@ # Start a Test Invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation Start-V2024TestTriggerInvocation-V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result # Below is a request that includes all optional parameters # Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $TestInvocation } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" 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: ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | ValidateFilterInputDto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True | ### Return type [**ValidateFilterOutputDto**](../models/validate-filter-output-dto) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Boolean whether specified filter expression is valid against the input. | ValidateFilterOutputDto 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 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $ValidateFilterInputDto = @"{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" } }"@ # Validate a Subscription Filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto Test-V2024SubscriptionFilter-V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result # Below is a request that includes all optional parameters # Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $ValidateFilterInputDto } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" 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: * id * triggerId Attempts to modify these fields result in 400. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Subscription ID | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SubscriptionPutRequest | [**SubscriptionPutRequest**](../models/subscription-put-request) | True | ### Return type [**Subscription**](../models/subscription) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Updated subscription. | Subscription 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 $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SubscriptionPutRequest = @"{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { "bearerToken" : "bearerToken" }, "httpAuthenticationType" : "BASIC_AUTH", "httpDispatchMode" : "SYNC", "basicAuthConfig" : { "password" : "password", "userName" : "user@example.com" }, "url" : "https://www.example.com" }, "name" : "Access request subscription", "description" : "Access requested to site xyz", "eventBridgeConfig" : { "awsRegion" : "us-west-1", "awsAccount" : "123456789012" }, "responseDeadline" : "PT1H", "type" : "HTTP", "enabled" : true }"@ # Update a Subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result # Below is a request that includes all optional parameters # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $SubscriptionPutRequest } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#)