mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
Update python SDK docs: 15116515953
This commit is contained in:
developer-relations-sp
@@ -56,20 +56,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**complete-trigger-invocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation
|
||||
[**create-subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription
|
||||
[**delete-subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription
|
||||
[**list-subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions
|
||||
[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses
|
||||
[**list-triggers**](#list-triggers) | **GET** `/triggers` | List Triggers
|
||||
[**patch-subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription
|
||||
[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation
|
||||
[**test-subscription-filter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
|
||||
[**update-subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
|
||||
[**complete-trigger-invocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete trigger invocation
|
||||
[**create-subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a subscription
|
||||
[**delete-subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a subscription
|
||||
[**list-subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List subscriptions
|
||||
[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List latest invocation statuses
|
||||
[**list-triggers**](#list-triggers) | **GET** `/triggers` | List triggers
|
||||
[**patch-subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a subscription
|
||||
[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a test invocation
|
||||
[**test-subscription-filter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a subscription filter
|
||||
[**update-subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a subscription
|
||||
|
||||
|
||||
## complete-trigger-invocation
|
||||
Complete Trigger Invocation
|
||||
Complete trigger invocation
|
||||
Completes an invocation to a REQUEST_RESPONSE type trigger.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation)
|
||||
@@ -119,7 +119,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # CompleteInvocation |
|
||||
|
||||
try:
|
||||
# Complete Trigger Invocation
|
||||
# Complete trigger invocation
|
||||
new_complete_invocation = CompleteInvocation.from_json(complete_invocation)
|
||||
TriggersApi(api_client).complete_trigger_invocation(id=id, complete_invocation=new_complete_invocation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -133,7 +133,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-subscription
|
||||
Create a Subscription
|
||||
Create a 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
|
||||
@@ -202,7 +202,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # SubscriptionPostRequest |
|
||||
|
||||
try:
|
||||
# Create a Subscription
|
||||
# Create a subscription
|
||||
new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request)
|
||||
results = TriggersApi(api_client).create_subscription(subscription_post_request=new_subscription_post_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -218,7 +218,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-subscription
|
||||
Delete a Subscription
|
||||
Delete a subscription
|
||||
Deletes an existing subscription to a trigger.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription)
|
||||
@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID
|
||||
|
||||
try:
|
||||
# Delete a Subscription
|
||||
# Delete a subscription
|
||||
|
||||
TriggersApi(api_client).delete_subscription(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -274,7 +274,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-subscriptions
|
||||
List Subscriptions
|
||||
List subscriptions
|
||||
Gets a list of all trigger subscriptions.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions)
|
||||
@@ -324,7 +324,7 @@ with ApiClient(configuration) as api_client:
|
||||
sorters = 'triggerName' # str | 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) # str | 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)
|
||||
|
||||
try:
|
||||
# List Subscriptions
|
||||
# List subscriptions
|
||||
|
||||
results = TriggersApi(api_client).list_subscriptions()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -341,7 +341,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-trigger-invocation-status
|
||||
List Latest Invocation Statuses
|
||||
List latest invocation statuses
|
||||
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.
|
||||
@@ -393,7 +393,7 @@ with ApiClient(configuration) as api_client:
|
||||
sorters = 'created' # str | 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) # str | 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)
|
||||
|
||||
try:
|
||||
# List Latest Invocation Statuses
|
||||
# List latest invocation statuses
|
||||
|
||||
results = TriggersApi(api_client).list_trigger_invocation_status()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -410,7 +410,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-triggers
|
||||
List Triggers
|
||||
List triggers
|
||||
Gets a list of triggers that are available in the tenant.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers)
|
||||
@@ -460,7 +460,7 @@ with ApiClient(configuration) as api_client:
|
||||
sorters = 'name' # str | 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) # str | 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)
|
||||
|
||||
try:
|
||||
# List Triggers
|
||||
# List triggers
|
||||
|
||||
results = TriggersApi(api_client).list_triggers()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -477,7 +477,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-subscription
|
||||
Patch a Subscription
|
||||
Patch a 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**
|
||||
@@ -525,7 +525,7 @@ with ApiClient(configuration) as api_client:
|
||||
subscription_patch_request_inner = '''[sailpoint.beta.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] |
|
||||
|
||||
try:
|
||||
# Patch a Subscription
|
||||
# Patch a subscription
|
||||
new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner)
|
||||
results = TriggersApi(api_client).patch_subscription(id=id, subscription_patch_request_inner=new_subscription_patch_request_inner)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -541,7 +541,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-test-trigger-invocation
|
||||
Start a Test Invocation
|
||||
Start a test 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-test-trigger-invocation)
|
||||
@@ -594,7 +594,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # TestInvocation |
|
||||
|
||||
try:
|
||||
# Start a Test Invocation
|
||||
# Start a test invocation
|
||||
new_test_invocation = TestInvocation.from_json(test_invocation)
|
||||
results = TriggersApi(api_client).start_test_trigger_invocation(test_invocation=new_test_invocation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -611,7 +611,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-subscription-filter
|
||||
Validate a Subscription Filter
|
||||
Validate a subscription filter
|
||||
Validates a JSONPath filter expression against a provided mock input.
|
||||
Request requires a security scope of:
|
||||
|
||||
@@ -660,7 +660,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # ValidateFilterInputDto |
|
||||
|
||||
try:
|
||||
# Validate a Subscription Filter
|
||||
# Validate a subscription filter
|
||||
new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto)
|
||||
results = TriggersApi(api_client).test_subscription_filter(validate_filter_input_dto=new_validate_filter_input_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -676,7 +676,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-subscription
|
||||
Update a Subscription
|
||||
Update a 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:
|
||||
|
||||
@@ -754,7 +754,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # SubscriptionPutRequest |
|
||||
|
||||
try:
|
||||
# Update a Subscription
|
||||
# Update a subscription
|
||||
new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request)
|
||||
results = TriggersApi(api_client).update_subscription(id=id, subscription_put_request=new_subscription_put_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
|
||||
Reference in New Issue
Block a user