/** * Identity Security Cloud API - Workflows * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface CreateExternalExecuteWorkflowV1200Response */ export interface CreateExternalExecuteWorkflowV1200Response { /** * The workflow execution id * @type {string} * @memberof CreateExternalExecuteWorkflowV1200Response */ 'workflowExecutionId'?: string; /** * An error message if any errors occurred * @type {string} * @memberof CreateExternalExecuteWorkflowV1200Response */ 'message'?: string; } /** * * @export * @interface CreateExternalExecuteWorkflowV1Request */ export interface CreateExternalExecuteWorkflowV1Request { /** * The input for the workflow * @type {object} * @memberof CreateExternalExecuteWorkflowV1Request */ 'input'?: object; } /** * * @export * @interface CreateWorkflowV1Request */ export interface CreateWorkflowV1Request { /** * The name of the workflow * @type {string} * @memberof CreateWorkflowV1Request */ 'name': string; /** * * @type {WorkflowBodyOwner} * @memberof CreateWorkflowV1Request */ 'owner'?: WorkflowBodyOwner; /** * Description of what the workflow accomplishes * @type {string} * @memberof CreateWorkflowV1Request */ 'description'?: string; /** * * @type {WorkflowDefinition} * @memberof CreateWorkflowV1Request */ 'definition'?: WorkflowDefinition; /** * Enable or disable the workflow. Workflows cannot be created in an enabled state. * @type {boolean} * @memberof CreateWorkflowV1Request */ 'enabled'?: boolean; /** * * @type {WorkflowTrigger} * @memberof CreateWorkflowV1Request */ 'trigger'?: WorkflowTrigger; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListCompleteWorkflowLibraryV1200ResponseInner */ export interface ListCompleteWorkflowLibraryV1200ResponseInner { /** * Operator ID. * @type {string} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'id'?: string; /** * Operator friendly name * @type {string} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'name'?: string; /** * Operator type * @type {string} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'type'?: string; /** * Description of the operator * @type {string} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'description'?: string; /** * One or more inputs that the operator accepts * @type {Array} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'formFields'?: Array | null; /** * * @type {WorkflowLibraryActionExampleOutput} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'exampleOutput'?: WorkflowLibraryActionExampleOutput; /** * * @type {boolean} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'deprecated'?: boolean; /** * * @type {string} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'deprecatedBy'?: string; /** * Version number * @type {number} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'versionNumber'?: number; /** * * @type {boolean} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'isSimulationEnabled'?: boolean; /** * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. * @type {boolean} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'isDynamicSchema'?: boolean; /** * Example output schema * @type {object} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'outputSchema'?: object; /** * Example trigger payload if applicable * @type {object} * @memberof ListCompleteWorkflowLibraryV1200ResponseInner */ 'inputExample'?: object | null; } /** * * @export * @interface ListWorkflowsV1401Response */ export interface ListWorkflowsV1401Response { /** * A message describing the error * @type {any} * @memberof ListWorkflowsV1401Response */ 'error'?: any; } /** * * @export * @interface ListWorkflowsV1429Response */ export interface ListWorkflowsV1429Response { /** * A message describing the error * @type {any} * @memberof ListWorkflowsV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface TestExternalExecuteWorkflowV1200Response */ export interface TestExternalExecuteWorkflowV1200Response { /** * The input that was received * @type {object} * @memberof TestExternalExecuteWorkflowV1200Response */ 'payload'?: object; } /** * * @export * @interface TestExternalExecuteWorkflowV1Request */ export interface TestExternalExecuteWorkflowV1Request { /** * The test input for the workflow * @type {object} * @memberof TestExternalExecuteWorkflowV1Request */ 'input'?: object; } /** * * @export * @interface TestWorkflowV1200Response */ export interface TestWorkflowV1200Response { /** * The workflow execution id * @type {string} * @memberof TestWorkflowV1200Response */ 'workflowExecutionId'?: string; } /** * * @export * @interface TestWorkflowV1Request */ export interface TestWorkflowV1Request { /** * The test input for the workflow. * @type {object} * @memberof TestWorkflowV1Request */ 'input': object; } /** * * @export * @interface Workflow */ export interface Workflow { /** * The name of the workflow * @type {string} * @memberof Workflow */ 'name'?: string; /** * * @type {WorkflowBodyOwner} * @memberof Workflow */ 'owner'?: WorkflowBodyOwner; /** * Description of what the workflow accomplishes * @type {string} * @memberof Workflow */ 'description'?: string; /** * * @type {WorkflowDefinition} * @memberof Workflow */ 'definition'?: WorkflowDefinition; /** * Enable or disable the workflow. Workflows cannot be created in an enabled state. * @type {boolean} * @memberof Workflow */ 'enabled'?: boolean; /** * * @type {WorkflowTrigger} * @memberof Workflow */ 'trigger'?: WorkflowTrigger; /** * Workflow ID. This is a UUID generated upon creation. * @type {string} * @memberof Workflow */ 'id'?: string; /** * The number of times this workflow has been executed. * @type {number} * @memberof Workflow */ 'executionCount'?: number; /** * The number of times this workflow has failed during execution. * @type {number} * @memberof Workflow */ 'failureCount'?: number; /** * The date and time the workflow was created. * @type {string} * @memberof Workflow */ 'created'?: string; /** * The date and time the workflow was modified. * @type {string} * @memberof Workflow */ 'modified'?: string; /** * * @type {WorkflowModifiedBy} * @memberof Workflow */ 'modifiedBy'?: WorkflowModifiedBy; /** * * @type {WorkflowAllOfCreator} * @memberof Workflow */ 'creator'?: WorkflowAllOfCreator; } /** * Workflow creator\'s identity. * @export * @interface WorkflowAllOfCreator */ export interface WorkflowAllOfCreator { /** * Workflow creator\'s DTO type. * @type {string} * @memberof WorkflowAllOfCreator */ 'type'?: WorkflowAllOfCreatorTypeEnum; /** * Workflow creator\'s identity ID. * @type {string} * @memberof WorkflowAllOfCreator */ 'id'?: string; /** * Workflow creator\'s display name. * @type {string} * @memberof WorkflowAllOfCreator */ 'name'?: string; } export declare const WorkflowAllOfCreatorTypeEnum: { readonly Identity: "IDENTITY"; }; export type WorkflowAllOfCreatorTypeEnum = typeof WorkflowAllOfCreatorTypeEnum[keyof typeof WorkflowAllOfCreatorTypeEnum]; /** * * @export * @interface WorkflowBody */ export interface WorkflowBody { /** * The name of the workflow * @type {string} * @memberof WorkflowBody */ 'name'?: string; /** * * @type {WorkflowBodyOwner} * @memberof WorkflowBody */ 'owner'?: WorkflowBodyOwner; /** * Description of what the workflow accomplishes * @type {string} * @memberof WorkflowBody */ 'description'?: string; /** * * @type {WorkflowDefinition} * @memberof WorkflowBody */ 'definition'?: WorkflowDefinition; /** * Enable or disable the workflow. Workflows cannot be created in an enabled state. * @type {boolean} * @memberof WorkflowBody */ 'enabled'?: boolean; /** * * @type {WorkflowTrigger} * @memberof WorkflowBody */ 'trigger'?: WorkflowTrigger; } /** * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. * @export * @interface WorkflowBodyOwner */ export interface WorkflowBodyOwner { /** * The type of object that is referenced * @type {string} * @memberof WorkflowBodyOwner */ 'type'?: WorkflowBodyOwnerTypeEnum; /** * The unique ID of the object * @type {string} * @memberof WorkflowBodyOwner */ 'id'?: string; /** * The name of the object * @type {string} * @memberof WorkflowBodyOwner */ 'name'?: string; } export declare const WorkflowBodyOwnerTypeEnum: { readonly Identity: "IDENTITY"; }; export type WorkflowBodyOwnerTypeEnum = typeof WorkflowBodyOwnerTypeEnum[keyof typeof WorkflowBodyOwnerTypeEnum]; /** * The map of steps that the workflow will execute. * @export * @interface WorkflowDefinition */ export interface WorkflowDefinition { /** * The name of the starting step. * @type {string} * @memberof WorkflowDefinition */ 'start'?: string; /** * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. * @type {{ [key: string]: any; }} * @memberof WorkflowDefinition */ 'steps'?: { [key: string]: any; }; } /** * * @export * @interface WorkflowExecution */ export interface WorkflowExecution { /** * Workflow execution ID. * @type {string} * @memberof WorkflowExecution */ 'id'?: string; /** * Workflow ID. * @type {string} * @memberof WorkflowExecution */ 'workflowId'?: string; /** * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. * @type {string} * @memberof WorkflowExecution */ 'requestId'?: string; /** * Date/time when the workflow started. * @type {string} * @memberof WorkflowExecution */ 'startTime'?: string; /** * Date/time when the workflow ended. * @type {string} * @memberof WorkflowExecution */ 'closeTime'?: string; /** * Workflow execution status. * @type {string} * @memberof WorkflowExecution */ 'status'?: WorkflowExecutionStatusEnum; } export declare const WorkflowExecutionStatusEnum: { readonly Completed: "Completed"; readonly Failed: "Failed"; readonly Canceled: "Canceled"; readonly Running: "Running"; readonly Queued: "Queued"; }; export type WorkflowExecutionStatusEnum = typeof WorkflowExecutionStatusEnum[keyof typeof WorkflowExecutionStatusEnum]; /** * * @export * @interface WorkflowExecutionEvent */ export interface WorkflowExecutionEvent { /** * The type of event * @type {string} * @memberof WorkflowExecutionEvent */ 'type'?: WorkflowExecutionEventTypeEnum; /** * The date-time when the event occurred * @type {string} * @memberof WorkflowExecutionEvent */ 'timestamp'?: string; /** * Additional attributes associated with the event * @type {object} * @memberof WorkflowExecutionEvent */ 'attributes'?: object; } export declare const WorkflowExecutionEventTypeEnum: { readonly WorkflowExecutionScheduled: "WorkflowExecutionScheduled"; readonly WorkflowExecutionStarted: "WorkflowExecutionStarted"; readonly WorkflowExecutionCompleted: "WorkflowExecutionCompleted"; readonly WorkflowExecutionFailed: "WorkflowExecutionFailed"; readonly WorkflowTaskScheduled: "WorkflowTaskScheduled"; readonly WorkflowTaskStarted: "WorkflowTaskStarted"; readonly WorkflowTaskCompleted: "WorkflowTaskCompleted"; readonly WorkflowTaskFailed: "WorkflowTaskFailed"; readonly ActivityTaskScheduled: "ActivityTaskScheduled"; readonly ActivityTaskStarted: "ActivityTaskStarted"; readonly ActivityTaskCompleted: "ActivityTaskCompleted"; readonly ActivityTaskFailed: "ActivityTaskFailed"; readonly StartChildWorkflowExecutionInitiated: "StartChildWorkflowExecutionInitiated"; readonly ChildWorkflowExecutionStarted: "ChildWorkflowExecutionStarted"; readonly ChildWorkflowExecutionCompleted: "ChildWorkflowExecutionCompleted"; readonly ChildWorkflowExecutionFailed: "ChildWorkflowExecutionFailed"; }; export type WorkflowExecutionEventTypeEnum = typeof WorkflowExecutionEventTypeEnum[keyof typeof WorkflowExecutionEventTypeEnum]; /** * * @export * @interface WorkflowExecutionHistory */ export interface WorkflowExecutionHistory { /** * * @type {object} * @memberof WorkflowExecutionHistory */ 'definition'?: object; /** * * @type {object} * @memberof WorkflowExecutionHistory */ 'history'?: object; /** * * @type {object} * @memberof WorkflowExecutionHistory */ 'trigger'?: object; } /** * * @export * @interface WorkflowLibraryAction */ export interface WorkflowLibraryAction { /** * Action ID. This is a static namespaced ID for the action * @type {string} * @memberof WorkflowLibraryAction */ 'id'?: string; /** * Action Name * @type {string} * @memberof WorkflowLibraryAction */ 'name'?: string; /** * Action type * @type {string} * @memberof WorkflowLibraryAction */ 'type'?: string; /** * Action Description * @type {string} * @memberof WorkflowLibraryAction */ 'description'?: string; /** * One or more inputs that the action accepts * @type {Array} * @memberof WorkflowLibraryAction */ 'formFields'?: Array | null; /** * * @type {WorkflowLibraryActionExampleOutput} * @memberof WorkflowLibraryAction */ 'exampleOutput'?: WorkflowLibraryActionExampleOutput; /** * * @type {boolean} * @memberof WorkflowLibraryAction */ 'deprecated'?: boolean; /** * * @type {string} * @memberof WorkflowLibraryAction */ 'deprecatedBy'?: string; /** * Version number * @type {number} * @memberof WorkflowLibraryAction */ 'versionNumber'?: number; /** * * @type {boolean} * @memberof WorkflowLibraryAction */ 'isSimulationEnabled'?: boolean; /** * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. * @type {boolean} * @memberof WorkflowLibraryAction */ 'isDynamicSchema'?: boolean; /** * Defines the output schema, if any, that this action produces. * @type {object} * @memberof WorkflowLibraryAction */ 'outputSchema'?: object; } /** * @type WorkflowLibraryActionExampleOutput * @export */ export type WorkflowLibraryActionExampleOutput = Array | object; /** * * @export * @interface WorkflowLibraryFormFields */ export interface WorkflowLibraryFormFields { /** * Description of the form field * @type {string} * @memberof WorkflowLibraryFormFields */ 'description'?: string; /** * Describes the form field in the UI * @type {string} * @memberof WorkflowLibraryFormFields */ 'helpText'?: string; /** * A human readable name for this form field in the UI * @type {string} * @memberof WorkflowLibraryFormFields */ 'label'?: string; /** * The name of the input attribute * @type {string} * @memberof WorkflowLibraryFormFields */ 'name'?: string; /** * Denotes if this field is a required attribute * @type {boolean} * @memberof WorkflowLibraryFormFields */ 'required'?: boolean; /** * The type of the form field * @type {string} * @memberof WorkflowLibraryFormFields */ 'type'?: WorkflowLibraryFormFieldsTypeEnum | null; } export declare const WorkflowLibraryFormFieldsTypeEnum: { readonly Text: "text"; readonly Textarea: "textarea"; readonly Boolean: "boolean"; readonly Email: "email"; readonly Url: "url"; readonly Number: "number"; readonly Json: "json"; readonly Checkbox: "checkbox"; readonly Jsonpath: "jsonpath"; readonly Select: "select"; readonly MultiType: "multiType"; readonly Duration: "duration"; readonly Toggle: "toggle"; readonly FormPicker: "formPicker"; readonly IdentityPicker: "identityPicker"; readonly GovernanceGroupPicker: "governanceGroupPicker"; readonly String: "string"; readonly Object: "object"; readonly Array: "array"; readonly Secret: "secret"; readonly KeyValuePairs: "keyValuePairs"; readonly EmailPicker: "emailPicker"; readonly AdvancedToggle: "advancedToggle"; readonly VariableCreator: "variableCreator"; readonly HtmlEditor: "htmlEditor"; }; export type WorkflowLibraryFormFieldsTypeEnum = typeof WorkflowLibraryFormFieldsTypeEnum[keyof typeof WorkflowLibraryFormFieldsTypeEnum]; /** * * @export * @interface WorkflowLibraryOperator */ export interface WorkflowLibraryOperator { /** * Operator ID. * @type {string} * @memberof WorkflowLibraryOperator */ 'id'?: string; /** * Operator friendly name * @type {string} * @memberof WorkflowLibraryOperator */ 'name'?: string; /** * Operator type * @type {string} * @memberof WorkflowLibraryOperator */ 'type'?: string; /** * Description of the operator * @type {string} * @memberof WorkflowLibraryOperator */ 'description'?: string; /** * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. * @type {boolean} * @memberof WorkflowLibraryOperator */ 'isDynamicSchema'?: boolean; /** * * @type {boolean} * @memberof WorkflowLibraryOperator */ 'deprecated'?: boolean; /** * * @type {string} * @memberof WorkflowLibraryOperator */ 'deprecatedBy'?: string; /** * * @type {boolean} * @memberof WorkflowLibraryOperator */ 'isSimulationEnabled'?: boolean; /** * One or more inputs that the operator accepts * @type {Array} * @memberof WorkflowLibraryOperator */ 'formFields'?: Array | null; } /** * * @export * @interface WorkflowLibraryTrigger */ export interface WorkflowLibraryTrigger { /** * Trigger ID. This is a static namespaced ID for the trigger. * @type {string} * @memberof WorkflowLibraryTrigger */ 'id'?: string; /** * Trigger type * @type {string} * @memberof WorkflowLibraryTrigger */ 'type'?: WorkflowLibraryTriggerTypeEnum; /** * Whether the trigger is deprecated. * @type {boolean} * @memberof WorkflowLibraryTrigger */ 'deprecated'?: boolean; /** * Date the trigger was deprecated, if applicable. * @type {string} * @memberof WorkflowLibraryTrigger */ 'deprecatedBy'?: string; /** * Whether the trigger can be simulated. * @type {boolean} * @memberof WorkflowLibraryTrigger */ 'isSimulationEnabled'?: boolean; /** * Example output schema * @type {object} * @memberof WorkflowLibraryTrigger */ 'outputSchema'?: object; /** * Trigger Name * @type {string} * @memberof WorkflowLibraryTrigger */ 'name'?: string; /** * Trigger Description * @type {string} * @memberof WorkflowLibraryTrigger */ 'description'?: string; /** * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. * @type {boolean} * @memberof WorkflowLibraryTrigger */ 'isDynamicSchema'?: boolean; /** * Example trigger payload if applicable * @type {object} * @memberof WorkflowLibraryTrigger */ 'inputExample'?: object | null; /** * One or more inputs that the trigger accepts * @type {Array} * @memberof WorkflowLibraryTrigger */ 'formFields'?: Array | null; } export declare const WorkflowLibraryTriggerTypeEnum: { readonly Event: "EVENT"; readonly Scheduled: "SCHEDULED"; readonly External: "EXTERNAL"; readonly AccessRequestTrigger: "AccessRequestTrigger"; }; export type WorkflowLibraryTriggerTypeEnum = typeof WorkflowLibraryTriggerTypeEnum[keyof typeof WorkflowLibraryTriggerTypeEnum]; /** * * @export * @interface WorkflowModifiedBy */ export interface WorkflowModifiedBy { /** * * @type {string} * @memberof WorkflowModifiedBy */ 'type'?: WorkflowModifiedByTypeEnum; /** * Identity ID * @type {string} * @memberof WorkflowModifiedBy */ 'id'?: string; /** * Human-readable display name of identity. * @type {string} * @memberof WorkflowModifiedBy */ 'name'?: string; } export declare const WorkflowModifiedByTypeEnum: { readonly Identity: "IDENTITY"; }; export type WorkflowModifiedByTypeEnum = typeof WorkflowModifiedByTypeEnum[keyof typeof WorkflowModifiedByTypeEnum]; /** * * @export * @interface WorkflowOAuthClient */ export interface WorkflowOAuthClient { /** * OAuth client ID for the trigger. This is a UUID generated upon creation. * @type {string} * @memberof WorkflowOAuthClient */ 'id'?: string; /** * OAuthClient secret. * @type {string} * @memberof WorkflowOAuthClient */ 'secret'?: string; /** * URL for the external trigger to invoke * @type {string} * @memberof WorkflowOAuthClient */ 'url'?: string; } /** * The trigger that starts the workflow * @export * @interface WorkflowTrigger */ export interface WorkflowTrigger { /** * The trigger type * @type {string} * @memberof WorkflowTrigger */ 'type': WorkflowTriggerTypeEnum; /** * The trigger display name * @type {string} * @memberof WorkflowTrigger */ 'displayName'?: string | null; /** * Workflow Trigger Attributes. * @type {object} * @memberof WorkflowTrigger */ 'attributes': object | null; } export declare const WorkflowTriggerTypeEnum: { readonly Event: "EVENT"; readonly External: "EXTERNAL"; readonly Scheduled: "SCHEDULED"; readonly Empty: ""; }; export type WorkflowTriggerTypeEnum = typeof WorkflowTriggerTypeEnum[keyof typeof WorkflowTriggerTypeEnum]; /** * WorkflowsApi - axios parameter creator * @export */ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Use this API to cancel a running workflow execution. * @summary Cancel workflow execution by id * @param {string} id The workflow execution ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelWorkflowExecutionV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Execute workflow via external trigger * @param {string} id Id of the workflow * @param {CreateExternalExecuteWorkflowV1Request} [createExternalExecuteWorkflowV1Request] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createExternalExecuteWorkflowV1: (id: string, createExternalExecuteWorkflowV1Request?: CreateExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Generate external trigger oauth client * @param {string} id Id of the workflow * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowExternalTriggerV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a new workflow with the desired trigger and steps specified in the request body. * @summary Create workflow * @param {CreateWorkflowV1Request} createWorkflowV1Request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowV1: (createWorkflowV1Request: CreateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. * @summary Delete workflow by id * @param {string} id Id of the Workflow * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteWorkflowV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Get workflow execution history * @param {string} id Id of the workflow execution * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionHistoryV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Gets a workflow execution history, trigger input, and workflow definition 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. * @summary Get updated workflow execution history * @param {string} id Id of the workflow execution * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionHistoryV2: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to 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. * @summary Get workflow execution * @param {string} id Workflow execution ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * [Deprecated] This endpoint will be removed in July 2028. 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/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. * @summary List workflow executions * @param {string} id Workflow ID. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {string} [filters] 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getWorkflowExecutionsV1: (id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get a single workflow by id. * @summary Get workflow by id * @param {string} id Id of the workflow * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This lists all triggers, actions, and operators in the library * @summary List complete workflow library * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCompleteWorkflowLibraryV1: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This lists the workflow actions available to you. * @summary List workflow library actions * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {string} [filters] 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* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryActionsV1: (limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This lists the workflow operators available to you * @summary List workflow library operators * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryOperatorsV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This lists the workflow triggers available to you * @summary List workflow library triggers * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {string} [filters] 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* **name**: *eq* **type**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryTriggersV1: (limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * List all workflows in the tenant. * @summary List workflows * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowsV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. * @summary Patch workflow * @param {string} id Id of the Workflow * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchWorkflowV1: (id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Perform a full update of a workflow. The updated workflow object is returned in the response. * @summary Update workflow * @param {string} id Id of the Workflow * @param {WorkflowBody} workflowBody * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putWorkflowV1: (id: string, workflowBody: WorkflowBody, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Test workflow via external trigger * @param {string} id Id of the workflow * @param {TestExternalExecuteWorkflowV1Request} [testExternalExecuteWorkflowV1Request] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testExternalExecuteWorkflowV1: (id: string, testExternalExecuteWorkflowV1Request?: TestExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * :::info Workflow must be disabled in order to use this endpoint. ::: 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/docs/extensibility/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.** * @summary Test workflow by id * @param {string} id Id of the workflow * @param {TestWorkflowV1Request} testWorkflowV1Request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testWorkflowV1: (id: string, testWorkflowV1Request: TestWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * WorkflowsApi - functional programming interface * @export */ export declare const WorkflowsApiFp: (configuration?: Configuration) => { /** * Use this API to cancel a running workflow execution. * @summary Cancel workflow execution by id * @param {string} id The workflow execution ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelWorkflowExecutionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Execute workflow via external trigger * @param {string} id Id of the workflow * @param {CreateExternalExecuteWorkflowV1Request} [createExternalExecuteWorkflowV1Request] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createExternalExecuteWorkflowV1(id: string, createExternalExecuteWorkflowV1Request?: CreateExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Generate external trigger oauth client * @param {string} id Id of the workflow * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowExternalTriggerV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new workflow with the desired trigger and steps specified in the request body. * @summary Create workflow * @param {CreateWorkflowV1Request} createWorkflowV1Request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowV1(createWorkflowV1Request: CreateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. * @summary Delete workflow by id * @param {string} id Id of the Workflow * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteWorkflowV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Get workflow execution history * @param {string} id Id of the workflow execution * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionHistoryV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Gets a workflow execution history, trigger input, and workflow definition 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. * @summary Get updated workflow execution history * @param {string} id Id of the workflow execution * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionHistoryV2(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to 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. * @summary Get workflow execution * @param {string} id Workflow execution ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * [Deprecated] This endpoint will be removed in July 2028. 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/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. * @summary List workflow executions * @param {string} id Workflow ID. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {string} [filters] 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getWorkflowExecutionsV1(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get a single workflow by id. * @summary Get workflow by id * @param {string} id Id of the workflow * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This lists all triggers, actions, and operators in the library * @summary List complete workflow library * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCompleteWorkflowLibraryV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This lists the workflow actions available to you. * @summary List workflow library actions * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {string} [filters] 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* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryActionsV1(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This lists the workflow operators available to you * @summary List workflow library operators * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryOperatorsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This lists the workflow triggers available to you * @summary List workflow library triggers * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {string} [filters] 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* **name**: *eq* **type**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryTriggersV1(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * List all workflows in the tenant. * @summary List workflows * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. * @summary Patch workflow * @param {string} id Id of the Workflow * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchWorkflowV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Perform a full update of a workflow. The updated workflow object is returned in the response. * @summary Update workflow * @param {string} id Id of the Workflow * @param {WorkflowBody} workflowBody * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putWorkflowV1(id: string, workflowBody: WorkflowBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Test workflow via external trigger * @param {string} id Id of the workflow * @param {TestExternalExecuteWorkflowV1Request} [testExternalExecuteWorkflowV1Request] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testExternalExecuteWorkflowV1(id: string, testExternalExecuteWorkflowV1Request?: TestExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * :::info Workflow must be disabled in order to use this endpoint. ::: 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/docs/extensibility/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.** * @summary Test workflow by id * @param {string} id Id of the workflow * @param {TestWorkflowV1Request} testWorkflowV1Request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testWorkflowV1(id: string, testWorkflowV1Request: TestWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowsApi - factory interface * @export */ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Use this API to cancel a running workflow execution. * @summary Cancel workflow execution by id * @param {WorkflowsApiCancelWorkflowExecutionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelWorkflowExecutionV1(requestParameters: WorkflowsApiCancelWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Execute workflow via external trigger * @param {WorkflowsApiCreateExternalExecuteWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createExternalExecuteWorkflowV1(requestParameters: WorkflowsApiCreateExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Generate external trigger oauth client * @param {WorkflowsApiCreateWorkflowExternalTriggerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowExternalTriggerV1(requestParameters: WorkflowsApiCreateWorkflowExternalTriggerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a new workflow with the desired trigger and steps specified in the request body. * @summary Create workflow * @param {WorkflowsApiCreateWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowV1(requestParameters: WorkflowsApiCreateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. * @summary Delete workflow by id * @param {WorkflowsApiDeleteWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteWorkflowV1(requestParameters: WorkflowsApiDeleteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Get workflow execution history * @param {WorkflowsApiGetWorkflowExecutionHistoryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionHistoryV1(requestParameters: WorkflowsApiGetWorkflowExecutionHistoryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Gets a workflow execution history, trigger input, and workflow definition 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. * @summary Get updated workflow execution history * @param {WorkflowsApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionHistoryV2(requestParameters: WorkflowsApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to 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. * @summary Get workflow execution * @param {WorkflowsApiGetWorkflowExecutionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowExecutionV1(requestParameters: WorkflowsApiGetWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * [Deprecated] This endpoint will be removed in July 2028. 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/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. * @summary List workflow executions * @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getWorkflowExecutionsV1(requestParameters: WorkflowsApiGetWorkflowExecutionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Get a single workflow by id. * @summary Get workflow by id * @param {WorkflowsApiGetWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowV1(requestParameters: WorkflowsApiGetWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This lists all triggers, actions, and operators in the library * @summary List complete workflow library * @param {WorkflowsApiListCompleteWorkflowLibraryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCompleteWorkflowLibraryV1(requestParameters?: WorkflowsApiListCompleteWorkflowLibraryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This lists the workflow actions available to you. * @summary List workflow library actions * @param {WorkflowsApiListWorkflowLibraryActionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryActionsV1(requestParameters?: WorkflowsApiListWorkflowLibraryActionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This lists the workflow operators available to you * @summary List workflow library operators * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryOperatorsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This lists the workflow triggers available to you * @summary List workflow library triggers * @param {WorkflowsApiListWorkflowLibraryTriggersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowLibraryTriggersV1(requestParameters?: WorkflowsApiListWorkflowLibraryTriggersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * List all workflows in the tenant. * @summary List workflows * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listWorkflowsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. * @summary Patch workflow * @param {WorkflowsApiPatchWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchWorkflowV1(requestParameters: WorkflowsApiPatchWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Perform a full update of a workflow. The updated workflow object is returned in the response. * @summary Update workflow * @param {WorkflowsApiPutWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putWorkflowV1(requestParameters: WorkflowsApiPutWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Test workflow via external trigger * @param {WorkflowsApiTestExternalExecuteWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testExternalExecuteWorkflowV1(requestParameters: WorkflowsApiTestExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * :::info Workflow must be disabled in order to use this endpoint. ::: 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/docs/extensibility/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.** * @summary Test workflow by id * @param {WorkflowsApiTestWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testWorkflowV1(requestParameters: WorkflowsApiTestWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for cancelWorkflowExecutionV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiCancelWorkflowExecutionV1Request */ export interface WorkflowsApiCancelWorkflowExecutionV1Request { /** * The workflow execution ID * @type {string} * @memberof WorkflowsApiCancelWorkflowExecutionV1 */ readonly id: string; } /** * Request parameters for createExternalExecuteWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiCreateExternalExecuteWorkflowV1Request */ export interface WorkflowsApiCreateExternalExecuteWorkflowV1Request { /** * Id of the workflow * @type {string} * @memberof WorkflowsApiCreateExternalExecuteWorkflowV1 */ readonly id: string; /** * * @type {CreateExternalExecuteWorkflowV1Request} * @memberof WorkflowsApiCreateExternalExecuteWorkflowV1 */ readonly createExternalExecuteWorkflowV1Request?: CreateExternalExecuteWorkflowV1Request; } /** * Request parameters for createWorkflowExternalTriggerV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiCreateWorkflowExternalTriggerV1Request */ export interface WorkflowsApiCreateWorkflowExternalTriggerV1Request { /** * Id of the workflow * @type {string} * @memberof WorkflowsApiCreateWorkflowExternalTriggerV1 */ readonly id: string; } /** * Request parameters for createWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiCreateWorkflowV1Request */ export interface WorkflowsApiCreateWorkflowV1Request { /** * * @type {CreateWorkflowV1Request} * @memberof WorkflowsApiCreateWorkflowV1 */ readonly createWorkflowV1Request: CreateWorkflowV1Request; } /** * Request parameters for deleteWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiDeleteWorkflowV1Request */ export interface WorkflowsApiDeleteWorkflowV1Request { /** * Id of the Workflow * @type {string} * @memberof WorkflowsApiDeleteWorkflowV1 */ readonly id: string; } /** * Request parameters for getWorkflowExecutionHistoryV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiGetWorkflowExecutionHistoryV1Request */ export interface WorkflowsApiGetWorkflowExecutionHistoryV1Request { /** * Id of the workflow execution * @type {string} * @memberof WorkflowsApiGetWorkflowExecutionHistoryV1 */ readonly id: string; } /** * Request parameters for getWorkflowExecutionHistoryV2 operation in WorkflowsApi. * @export * @interface WorkflowsApiGetWorkflowExecutionHistoryV2Request */ export interface WorkflowsApiGetWorkflowExecutionHistoryV2Request { /** * Id of the workflow execution * @type {string} * @memberof WorkflowsApiGetWorkflowExecutionHistoryV2 */ readonly id: string; } /** * Request parameters for getWorkflowExecutionV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiGetWorkflowExecutionV1Request */ export interface WorkflowsApiGetWorkflowExecutionV1Request { /** * Workflow execution ID. * @type {string} * @memberof WorkflowsApiGetWorkflowExecutionV1 */ readonly id: string; } /** * Request parameters for getWorkflowExecutionsV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiGetWorkflowExecutionsV1Request */ export interface WorkflowsApiGetWorkflowExecutionsV1Request { /** * Workflow ID. * @type {string} * @memberof WorkflowsApiGetWorkflowExecutionsV1 */ readonly id: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof WorkflowsApiGetWorkflowExecutionsV1 */ readonly limit?: number; /** * 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. * @type {number} * @memberof WorkflowsApiGetWorkflowExecutionsV1 */ readonly offset?: number; /** * 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* * @type {string} * @memberof WorkflowsApiGetWorkflowExecutionsV1 */ readonly filters?: string; } /** * Request parameters for getWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiGetWorkflowV1Request */ export interface WorkflowsApiGetWorkflowV1Request { /** * Id of the workflow * @type {string} * @memberof WorkflowsApiGetWorkflowV1 */ readonly id: string; } /** * Request parameters for listCompleteWorkflowLibraryV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiListCompleteWorkflowLibraryV1Request */ export interface WorkflowsApiListCompleteWorkflowLibraryV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof WorkflowsApiListCompleteWorkflowLibraryV1 */ readonly limit?: number; /** * 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. * @type {number} * @memberof WorkflowsApiListCompleteWorkflowLibraryV1 */ readonly offset?: number; } /** * Request parameters for listWorkflowLibraryActionsV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiListWorkflowLibraryActionsV1Request */ export interface WorkflowsApiListWorkflowLibraryActionsV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof WorkflowsApiListWorkflowLibraryActionsV1 */ readonly limit?: number; /** * 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. * @type {number} * @memberof WorkflowsApiListWorkflowLibraryActionsV1 */ readonly offset?: number; /** * 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* * @type {string} * @memberof WorkflowsApiListWorkflowLibraryActionsV1 */ readonly filters?: string; } /** * Request parameters for listWorkflowLibraryTriggersV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiListWorkflowLibraryTriggersV1Request */ export interface WorkflowsApiListWorkflowLibraryTriggersV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof WorkflowsApiListWorkflowLibraryTriggersV1 */ readonly limit?: number; /** * 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. * @type {number} * @memberof WorkflowsApiListWorkflowLibraryTriggersV1 */ readonly offset?: number; /** * 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* **name**: *eq* **type**: *eq* * @type {string} * @memberof WorkflowsApiListWorkflowLibraryTriggersV1 */ readonly filters?: string; } /** * Request parameters for patchWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiPatchWorkflowV1Request */ export interface WorkflowsApiPatchWorkflowV1Request { /** * Id of the Workflow * @type {string} * @memberof WorkflowsApiPatchWorkflowV1 */ readonly id: string; /** * * @type {Array} * @memberof WorkflowsApiPatchWorkflowV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for putWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiPutWorkflowV1Request */ export interface WorkflowsApiPutWorkflowV1Request { /** * Id of the Workflow * @type {string} * @memberof WorkflowsApiPutWorkflowV1 */ readonly id: string; /** * * @type {WorkflowBody} * @memberof WorkflowsApiPutWorkflowV1 */ readonly workflowBody: WorkflowBody; } /** * Request parameters for testExternalExecuteWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiTestExternalExecuteWorkflowV1Request */ export interface WorkflowsApiTestExternalExecuteWorkflowV1Request { /** * Id of the workflow * @type {string} * @memberof WorkflowsApiTestExternalExecuteWorkflowV1 */ readonly id: string; /** * * @type {TestExternalExecuteWorkflowV1Request} * @memberof WorkflowsApiTestExternalExecuteWorkflowV1 */ readonly testExternalExecuteWorkflowV1Request?: TestExternalExecuteWorkflowV1Request; } /** * Request parameters for testWorkflowV1 operation in WorkflowsApi. * @export * @interface WorkflowsApiTestWorkflowV1Request */ export interface WorkflowsApiTestWorkflowV1Request { /** * Id of the workflow * @type {string} * @memberof WorkflowsApiTestWorkflowV1 */ readonly id: string; /** * * @type {TestWorkflowV1Request} * @memberof WorkflowsApiTestWorkflowV1 */ readonly testWorkflowV1Request: TestWorkflowV1Request; } /** * WorkflowsApi - object-oriented interface * @export * @class WorkflowsApi * @extends {BaseAPI} */ export declare class WorkflowsApi extends BaseAPI { /** * Use this API to cancel a running workflow execution. * @summary Cancel workflow execution by id * @param {WorkflowsApiCancelWorkflowExecutionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ cancelWorkflowExecutionV1(requestParameters: WorkflowsApiCancelWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Execute workflow via external trigger * @param {WorkflowsApiCreateExternalExecuteWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ createExternalExecuteWorkflowV1(requestParameters: WorkflowsApiCreateExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Generate external trigger oauth client * @param {WorkflowsApiCreateWorkflowExternalTriggerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ createWorkflowExternalTriggerV1(requestParameters: WorkflowsApiCreateWorkflowExternalTriggerV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a new workflow with the desired trigger and steps specified in the request body. * @summary Create workflow * @param {WorkflowsApiCreateWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ createWorkflowV1(requestParameters: WorkflowsApiCreateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. * @summary Delete workflow by id * @param {WorkflowsApiDeleteWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ deleteWorkflowV1(requestParameters: WorkflowsApiDeleteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Get workflow execution history * @param {WorkflowsApiGetWorkflowExecutionHistoryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ getWorkflowExecutionHistoryV1(requestParameters: WorkflowsApiGetWorkflowExecutionHistoryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Gets a workflow execution history, trigger input, and workflow definition 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. * @summary Get updated workflow execution history * @param {WorkflowsApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ getWorkflowExecutionHistoryV2(requestParameters: WorkflowsApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to 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. * @summary Get workflow execution * @param {WorkflowsApiGetWorkflowExecutionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ getWorkflowExecutionV1(requestParameters: WorkflowsApiGetWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * [Deprecated] This endpoint will be removed in July 2028. 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/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. * @summary List workflow executions * @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof WorkflowsApi */ getWorkflowExecutionsV1(requestParameters: WorkflowsApiGetWorkflowExecutionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get a single workflow by id. * @summary Get workflow by id * @param {WorkflowsApiGetWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ getWorkflowV1(requestParameters: WorkflowsApiGetWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This lists all triggers, actions, and operators in the library * @summary List complete workflow library * @param {WorkflowsApiListCompleteWorkflowLibraryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ listCompleteWorkflowLibraryV1(requestParameters?: WorkflowsApiListCompleteWorkflowLibraryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This lists the workflow actions available to you. * @summary List workflow library actions * @param {WorkflowsApiListWorkflowLibraryActionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ listWorkflowLibraryActionsV1(requestParameters?: WorkflowsApiListWorkflowLibraryActionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This lists the workflow operators available to you * @summary List workflow library operators * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ listWorkflowLibraryOperatorsV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This lists the workflow triggers available to you * @summary List workflow library triggers * @param {WorkflowsApiListWorkflowLibraryTriggersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ listWorkflowLibraryTriggersV1(requestParameters?: WorkflowsApiListWorkflowLibraryTriggersV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * List all workflows in the tenant. * @summary List workflows * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ listWorkflowsV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. * @summary Patch workflow * @param {WorkflowsApiPatchWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ patchWorkflowV1(requestParameters: WorkflowsApiPatchWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Perform a full update of a workflow. The updated workflow object is returned in the response. * @summary Update workflow * @param {WorkflowsApiPutWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ putWorkflowV1(requestParameters: WorkflowsApiPutWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Test workflow via external trigger * @param {WorkflowsApiTestExternalExecuteWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ testExternalExecuteWorkflowV1(requestParameters: WorkflowsApiTestExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * :::info Workflow must be disabled in order to use this endpoint. ::: 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/docs/extensibility/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.** * @summary Test workflow by id * @param {WorkflowsApiTestWorkflowV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ testWorkflowV1(requestParameters: WorkflowsApiTestWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }