Update python SDK docs: 15116515953

2025-12-08 12:27:47 +00:00 · 2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
--- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md
+++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md
@@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*

 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID
-[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow
-[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id
-[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id
-[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution
-[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History
-[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions
-[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library
-[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions
-[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators
-[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers
-[**list-workflows**](#list-workflows) | **GET** `/workflows` | List Workflows
-[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow
-[**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger
-[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client
-[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow
-[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
-[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
+[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id
+[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create workflow
+[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id
+[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id
+[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution
+[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history
+[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions
+[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library
+[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions
+[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators
+[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers
+[**list-workflows**](#list-workflows) | **GET** `/workflows` | List workflows
+[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow
+[**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger
+[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client
+[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow
+[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger
+[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id


 ## cancel-workflow-execution
-Cancel Workflow Execution by ID
+Cancel workflow execution by id
 Use this API to cancel a running workflow execution.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-workflow-execution)
@@ -79,7 +79,7 @@ with ApiClient(configuration) as api_client:
    id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID

    try:
-        # Cancel Workflow Execution by ID
+        # Cancel workflow execution by id
        
        WorkflowsApi(api_client).cancel_workflow_execution(id=id)
        # Below is a request that includes all optional parameters
@@ -93,7 +93,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## create-workflow
-Create Workflow
+Create workflow
 Create a new workflow with the desired trigger and steps specified in the request body.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/create-workflow)
@@ -136,7 +136,7 @@ with ApiClient(configuration) as api_client:
    create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | 

    try:
-        # Create Workflow
+        # Create workflow
        new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request)
        results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request)
        # Below is a request that includes all optional parameters
@@ -152,7 +152,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## delete-workflow
-Delete Workflow By Id
+Delete workflow by id
 Delete a workflow.  **Enabled workflows cannot be deleted**.  They must first be disabled.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workflow)
@@ -193,7 +193,7 @@ with ApiClient(configuration) as api_client:
    id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow

    try:
-        # Delete Workflow By Id
+        # Delete workflow by id
        
        WorkflowsApi(api_client).delete_workflow(id=id)
        # Below is a request that includes all optional parameters
@@ -207,7 +207,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-workflow
-Get Workflow By Id
+Get workflow by id
 Get a single workflow by id.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow)
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
    workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True)

    try:
-        # Get Workflow By Id
+        # Get workflow by id
        
        results = WorkflowsApi(api_client).get_workflow(id=id)
        # Below is a request that includes all optional parameters
@@ -267,7 +267,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-workflow-execution
-Get Workflow Execution
+Get workflow execution
 Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution)
@@ -309,7 +309,7 @@ with ApiClient(configuration) as api_client:
    id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID.

    try:
-        # Get Workflow Execution
+        # Get workflow execution
        
        results = WorkflowsApi(api_client).get_workflow_execution(id=id)
        # Below is a request that includes all optional parameters
@@ -325,7 +325,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-workflow-execution-history
-Get Workflow Execution History
+Get workflow execution history
 Get a detailed history of a single workflow execution.  Workflow executions are available for up to 90 days before being archived.  If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution-history)
@@ -368,7 +368,7 @@ with ApiClient(configuration) as api_client:
    id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution

    try:
-        # Get Workflow Execution History
+        # Get workflow execution history
        
        results = WorkflowsApi(api_client).get_workflow_execution_history(id=id)
        # Below is a request that includes all optional parameters
@@ -385,7 +385,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-workflow-executions
-List Workflow Executions
+List workflow executions
 Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions.  To get executions past the first 250 records, you can do the following: 
 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 
 2. Get your workflow ID from the response. 
@@ -446,7 +446,7 @@ with ApiClient(configuration) as api_client:
    filters = 'status eq \"Failed\"' # str | 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:  **startTime**: *eq, lt, le, gt, ge*  **status**: *eq* (optional) # str | 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:  **startTime**: *eq, lt, le, gt, ge*  **status**: *eq* (optional)

    try:
-        # List Workflow Executions
+        # List workflow executions
        
        results = WorkflowsApi(api_client).get_workflow_executions(id=id)
        # Below is a request that includes all optional parameters
@@ -463,7 +463,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## list-complete-workflow-library
-List Complete Workflow Library
+List complete workflow library
 This lists all triggers, actions, and operators in the library

 [API Spec](https://developer.sailpoint.com/docs/api/beta/list-complete-workflow-library)
@@ -507,7 +507,7 @@ with ApiClient(configuration) as api_client:
    offset = 0 # int | 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) # int | 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)

    try:
-        # List Complete Workflow Library
+        # List complete workflow library
        
        results = WorkflowsApi(api_client).list_complete_workflow_library()
        # Below is a request that includes all optional parameters
@@ -524,7 +524,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## list-workflow-library-actions
-List Workflow Library Actions
+List workflow library actions
 This lists the workflow actions available to you.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-actions)
@@ -570,7 +570,7 @@ with ApiClient(configuration) as api_client:
    filters = 'id eq \"sp:create-campaign\"' # str | 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* (optional) # str | 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* (optional)

    try:
-        # List Workflow Library Actions
+        # List workflow library actions
        
        results = WorkflowsApi(api_client).list_workflow_library_actions()
        # Below is a request that includes all optional parameters
@@ -587,7 +587,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## list-workflow-library-operators
-List Workflow Library Operators
+List workflow library operators
 This lists the workflow operators available to you

 [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-operators)
@@ -625,7 +625,7 @@ configuration = Configuration()
 with ApiClient(configuration) as api_client:

    try:
-        # List Workflow Library Operators
+        # List workflow library operators
        
        results = WorkflowsApi(api_client).list_workflow_library_operators()
        # Below is a request that includes all optional parameters
@@ -642,7 +642,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## list-workflow-library-triggers
-List Workflow Library Triggers
+List workflow library triggers
 This lists the workflow triggers available to you

 [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-triggers)
@@ -688,7 +688,7 @@ with ApiClient(configuration) as api_client:
    filters = 'id eq \"idn:identity-attributes-changed\"' # str | 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* (optional) # str | 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* (optional)

    try:
-        # List Workflow Library Triggers
+        # List workflow library triggers
        
        results = WorkflowsApi(api_client).list_workflow_library_triggers()
        # Below is a request that includes all optional parameters
@@ -705,7 +705,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## list-workflows
-List Workflows
+List workflows
 List all workflows in the tenant.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows)
@@ -753,7 +753,7 @@ with ApiClient(configuration) as api_client:
    connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional)

    try:
-        # List Workflows
+        # List workflows
        
        results = WorkflowsApi(api_client).list_workflows()
        # Below is a request that includes all optional parameters
@@ -770,7 +770,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## patch-workflow
-Patch Workflow
+Patch workflow
 Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workflow)
@@ -815,7 +815,7 @@ with ApiClient(configuration) as api_client:
    json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | 

    try:
-        # Patch Workflow
+        # Patch workflow
        new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
        results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation)
        # Below is a request that includes all optional parameters
@@ -831,7 +831,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## post-external-execute-workflow
-Execute Workflow via External Trigger
+Execute workflow via external trigger
 This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step.  The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/post-external-execute-workflow)
@@ -876,7 +876,7 @@ with ApiClient(configuration) as api_client:
    post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest |  (optional)

    try:
-        # Execute Workflow via External Trigger
+        # Execute workflow via external trigger
        
        results = WorkflowsApi(api_client).post_external_execute_workflow(id=id)
        # Below is a request that includes all optional parameters
@@ -892,7 +892,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## post-workflow-external-trigger
-Generate External Trigger OAuth Client
+Generate external trigger oauth client
 Create OAuth client ID, client secret, and callback URL for use in an external trigger.  External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/post-workflow-external-trigger)
@@ -934,7 +934,7 @@ with ApiClient(configuration) as api_client:
    id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow

    try:
-        # Generate External Trigger OAuth Client
+        # Generate external trigger oauth client
        
        results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id)
        # Below is a request that includes all optional parameters
@@ -950,7 +950,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## put-workflow
-Update Workflow
+Update workflow
 Perform a full update of a workflow.  The updated workflow object is returned in the response.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow)
@@ -1034,7 +1034,7 @@ with ApiClient(configuration) as api_client:
        }''' # WorkflowBody | 

    try:
-        # Update Workflow
+        # Update workflow
        new_workflow_body = WorkflowBody.from_json(workflow_body)
        results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body)
        # Below is a request that includes all optional parameters
@@ -1050,7 +1050,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## test-external-execute-workflow
-Test Workflow via External Trigger
+Test workflow via external trigger
 Validate a workflow with an "External Trigger" can receive input.  The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.

 [API Spec](https://developer.sailpoint.com/docs/api/beta/test-external-execute-workflow)
@@ -1095,7 +1095,7 @@ with ApiClient(configuration) as api_client:
    test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest |  (optional)

    try:
-        # Test Workflow via External Trigger
+        # Test workflow via external trigger
        
        results = WorkflowsApi(api_client).test_external_execute_workflow(id=id)
        # Below is a request that includes all optional parameters
@@ -1111,7 +1111,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## test-workflow
-Test Workflow By Id
+Test workflow by id
 Test a workflow with the provided input data.  The input data should resemble the input that the trigger will send the workflow.  See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.
 This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.
 **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
@@ -1158,7 +1158,7 @@ with ApiClient(configuration) as api_client:
    test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | 

    try:
-        # Test Workflow By Id
+        # Test workflow by id
        new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request)
        results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request)
        # Below is a request that includes all optional parameters