---
id: launch-workflow
sidebar_label: Endpoint used to launch a Workflow.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"launchWorkflow","tags":["LaunchedWorkflows"],"description":"Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched.","parameters":[{"in":"query","name":"attributes","schema":{"type":"string","example":"input"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"workflowName"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"schemas":{"type":"array","description":"Schemas related to Launched Workflows.","items":{"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}},"workflowName":{"type":"string","description":"Name of the Workflow to launch.","example":"LCM Manage Passwords"},"input":{"type":"array","description":"A list of input attributes of the Launched Workflow.","items":{"properties":{"key":{"type":"string","description":"The attribute key.","example":"plan"},"value":{"type":"string","description":"The attribute value.","example":"<ProvisioningPlan>\n  <AccountRequest application=\"IIQ\" op=\"Modify\">\n    <Attributes>\n      <Map>\n        <entry key=\"attachmentConfigList\"/>\n        <entry key=\"attachments\"/>\n        <entry key=\"flow\" value=\"AccessRequest\"/>\n        <entry key=\"id\" value=\"c0a8019c8100148081810095445a0437\"/>\n        <entry key=\"interface\" value=\"LCM\"/>\n        <entry key=\"operation\" value=\"RoleAdd\"/>\n      </Map>\n    </Attributes>\n    <AttributeRequest assignmentId=\"b92d53be96e94b47bded399345236eb9\" name=\"assignedRoles\" op=\"Add\" value=\"Benefits Clerk\"/>\n  </AccountRequest>\n  <AccountRequest application=\"IIQ\" op=\"Modify\">\n    <Attributes>\n      <Map>\n        <entry key=\"attachmentConfigList\"/>\n        <entry key=\"attachments\"/>\n        <entry key=\"flow\" value=\"AccessRequest\"/>\n        <entry key=\"id\" value=\"c0a8019c810014808181009544650438\"/>\n        <entry key=\"interface\" value=\"LCM\"/>\n        <entry key=\"operation\" value=\"RoleAdd\"/>\n      </Map>\n    </Attributes>\n    <AttributeRequest assignmentId=\"e4ed87c2ad1f4f2cb13b35937ab1e78a\" name=\"assignedRoles\" op=\"Add\" value=\"Benefits Manager\"/>\n  </AccountRequest>\n  <Attributes>\n    <Map>\n      <entry key=\"identityRequestId\" value=\"0000000001\"/>\n      <entry key=\"requester\" value=\"spadmin\"/>\n      <entry key=\"source\" value=\"LCM\"/>\n    </Map>\n  </Attributes>\n  <ProvisioningTargets>\n    <ProvisioningTarget assignmentId=\"b92d53be96e94b47bded399345236eb9\" role=\"Benefits Clerk\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Clerk - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n    <ProvisioningTarget assignmentId=\"e4ed87c2ad1f4f2cb13b35937ab1e78a\" role=\"Benefits Manager\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Clerk - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Manager - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n    <ProvisioningTarget assignmentId=\"ce66fb154b1e428eb72cd11a66a15164\" retain=\"true\" role=\"Payroll Analyst\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Payroll General Access - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n      <AccountSelection applicationId=\"c0a8019c81001480818100953e3e0373\" applicationName=\"Composite_ERP_Global_Platform\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n  </ProvisioningTargets>\n  <Requesters>\n    <Reference class=\"sailpoint.object.Identity\" id=\"c0a8019c8100148081810094e34d00ea\" name=\"spadmin\"/>\n  </Requesters>\n</ProvisioningPlan>\n"},"type":{"type":"string","description":"The attribute type.","example":"application/xml"}}}}}}},"*/*":{"schema":{"properties":{"schemas":{"type":"array","description":"Schemas related to Launched Workflows.","items":{"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}},"workflowName":{"type":"string","description":"Name of the Workflow to launch.","example":"LCM Manage Passwords"},"input":{"type":"array","description":"A list of input attributes of the Launched Workflow.","items":{"properties":{"key":{"type":"string","description":"The attribute key.","example":"plan"},"value":{"type":"string","description":"The attribute value.","example":"<ProvisioningPlan>\n  <AccountRequest application=\"IIQ\" op=\"Modify\">\n    <Attributes>\n      <Map>\n        <entry key=\"attachmentConfigList\"/>\n        <entry key=\"attachments\"/>\n        <entry key=\"flow\" value=\"AccessRequest\"/>\n        <entry key=\"id\" value=\"c0a8019c8100148081810095445a0437\"/>\n        <entry key=\"interface\" value=\"LCM\"/>\n        <entry key=\"operation\" value=\"RoleAdd\"/>\n      </Map>\n    </Attributes>\n    <AttributeRequest assignmentId=\"b92d53be96e94b47bded399345236eb9\" name=\"assignedRoles\" op=\"Add\" value=\"Benefits Clerk\"/>\n  </AccountRequest>\n  <AccountRequest application=\"IIQ\" op=\"Modify\">\n    <Attributes>\n      <Map>\n        <entry key=\"attachmentConfigList\"/>\n        <entry key=\"attachments\"/>\n        <entry key=\"flow\" value=\"AccessRequest\"/>\n        <entry key=\"id\" value=\"c0a8019c810014808181009544650438\"/>\n        <entry key=\"interface\" value=\"LCM\"/>\n        <entry key=\"operation\" value=\"RoleAdd\"/>\n      </Map>\n    </Attributes>\n    <AttributeRequest assignmentId=\"e4ed87c2ad1f4f2cb13b35937ab1e78a\" name=\"assignedRoles\" op=\"Add\" value=\"Benefits Manager\"/>\n  </AccountRequest>\n  <Attributes>\n    <Map>\n      <entry key=\"identityRequestId\" value=\"0000000001\"/>\n      <entry key=\"requester\" value=\"spadmin\"/>\n      <entry key=\"source\" value=\"LCM\"/>\n    </Map>\n  </Attributes>\n  <ProvisioningTargets>\n    <ProvisioningTarget assignmentId=\"b92d53be96e94b47bded399345236eb9\" role=\"Benefits Clerk\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Clerk - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n    <ProvisioningTarget assignmentId=\"e4ed87c2ad1f4f2cb13b35937ab1e78a\" role=\"Benefits Manager\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Clerk - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Manager - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n    <ProvisioningTarget assignmentId=\"ce66fb154b1e428eb72cd11a66a15164\" retain=\"true\" role=\"Payroll Analyst\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Payroll General Access - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n      <AccountSelection applicationId=\"c0a8019c81001480818100953e3e0373\" applicationName=\"Composite_ERP_Global_Platform\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n  </ProvisioningTargets>\n  <Requesters>\n    <Reference class=\"sailpoint.object.Identity\" id=\"c0a8019c8100148081810094e34d00ea\" name=\"spadmin\"/>\n  </Requesters>\n</ProvisioningPlan>\n"},"type":{"type":"string","description":"The attribute type.","example":"application/xml"}}}}}}}}},"responses":{"201":{"description":"Executes a workflow and returns the resulting LaunchedWorkflow. **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**","content":{"application/json":{"schema":{"type":"object","description":"Response example for a POST request to execute a Workflow.","properties":{"targetName":{"type":"string","description":"Target name of the TaskResult.","example":"Ernest.Wagner"},"verified":{"type":"string","format":"date-time","description":"The verified date of the TaskResult.","example":"2022-05-26T11:17:13.481-05:00"},"partitioned":{"type":"boolean","description":"Flag to indicate if the TaskResult is partitioned.","example":false},"completed":{"type":"string","format":"date-time","description":"The completed date of the TaskResult.","example":"2022-05-26T11:17:13.678-05:00"},"type":{"type":"string","description":"Type of the TaskResult.","example":"LCM"},"launched":{"type":"string","description":"The launched date of the TaskResult."},"pendingSignOffs":{"type":"integer","description":"Number of pending signoffs of this TaskResult.","example":0},"urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow":{"type":"object","description":"LaunchedWorkflow properties.","properties":{"output":{"type":"array","items":{"properties":{"type":{"type":"string","description":"The output attribute type.","example":"application/int"},"value":{"type":"string","description":"The output attribute value.","example":"0"},"key":{"type":"string","description":"The output attribute key.","example":"workflowSummary"}}}},"retries":{"type":"integer","description":"The number of retries performed during the execution of provisioning activities.","example":0},"input":{"type":"array","items":{"properties":{"key":{"type":"string","description":"The input attribute key.","example":"optimisticProvisioning"},"value":{"type":"string","description":"The input attribute value.","example":"true"},"type":{"type":"string","description":"The input attribute type.","example":"boolean"}}}},"workflowSummary":{"type":"string","description":"XML representation of the workflow summary.","example":"<WorkflowSummary step=\"end\"/>\n"},"workflowName":{"type":"string","description":"Name of the workflow to launch.","example":"LCM Manage Passwords."},"identityRequestId":{"type":"string","description":"Id representing the identity request.","example":"0000000004"},"workflowCaseId":{"type":"string","description":"Id representing the workflow case (a running instance of a workflow).","example":"c0a8019c810011478181012862b81568"}}},"targetClass":{"type":"string","description":"Target class of the Task Result.","example":"Identity"},"meta":{"description":"Metadata for the LaunchedWorkflow TaskResult.","type":"array","items":{"properties":{"created":{"description":"Datetime when the TaskResult for the LaunchedWorkflow was created.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the TaskResult.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c810011478181012862b51567"},"lastModified":{"description":"Datetime of LaunchedWorkflow TaskResult last modification","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"Version of the LaunchedWorkflow TaskResult.","type":"string","example":"\"W\"1649951092552\""},"resourceType":{"description":"Resource type of the metadata subject","type":"string","example":"LaunchedWorkflow"}}}},"schemas":{"type":"array","description":"Schemas related to LaunchedWorkflow.","items":{"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}},"name":{"type":"string","description":"Name of the TaskResult for the Workflow launch.","example":"LCM Manage Passwords - 2"},"messages":{"type":"array","description":"List of messages of the TaskResult.","items":{"example":["Connection error"]}},"Attributes":{"type":"object","description":"A list of attributes of the TaskResult.","properties":{"key":{"type":"string","description":"The attribute key.","example":"retries"},"value":{"type":"string","description":"The attribute value.","example":"0"}}},"id":{"type":"string","description":"Id of the task result for the Workflow launch.","example":"c0a8019c810011478181012862b51567"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult.","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult.","example":"Workflow Launcher"},"terminated":{"type":"boolean","description":"Flag to indicate this TaskResult is terminated.","example":false},"launcher":{"type":"string","description":"Launcher of the TaskResult.","example":"spadmin"}}}}}}},"method":"post","path":"/LaunchedWorkflows","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"schemas":[["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]],"workflowName":"LCM Manage Passwords","input":[{"key":"plan","value":"<ProvisioningPlan>\n  <AccountRequest application=\"IIQ\" op=\"Modify\">\n    <Attributes>\n      <Map>\n        <entry key=\"attachmentConfigList\"/>\n        <entry key=\"attachments\"/>\n        <entry key=\"flow\" value=\"AccessRequest\"/>\n        <entry key=\"id\" value=\"c0a8019c8100148081810095445a0437\"/>\n        <entry key=\"interface\" value=\"LCM\"/>\n        <entry key=\"operation\" value=\"RoleAdd\"/>\n      </Map>\n    </Attributes>\n    <AttributeRequest assignmentId=\"b92d53be96e94b47bded399345236eb9\" name=\"assignedRoles\" op=\"Add\" value=\"Benefits Clerk\"/>\n  </AccountRequest>\n  <AccountRequest application=\"IIQ\" op=\"Modify\">\n    <Attributes>\n      <Map>\n        <entry key=\"attachmentConfigList\"/>\n        <entry key=\"attachments\"/>\n        <entry key=\"flow\" value=\"AccessRequest\"/>\n        <entry key=\"id\" value=\"c0a8019c810014808181009544650438\"/>\n        <entry key=\"interface\" value=\"LCM\"/>\n        <entry key=\"operation\" value=\"RoleAdd\"/>\n      </Map>\n    </Attributes>\n    <AttributeRequest assignmentId=\"e4ed87c2ad1f4f2cb13b35937ab1e78a\" name=\"assignedRoles\" op=\"Add\" value=\"Benefits Manager\"/>\n  </AccountRequest>\n  <Attributes>\n    <Map>\n      <entry key=\"identityRequestId\" value=\"0000000001\"/>\n      <entry key=\"requester\" value=\"spadmin\"/>\n      <entry key=\"source\" value=\"LCM\"/>\n    </Map>\n  </Attributes>\n  <ProvisioningTargets>\n    <ProvisioningTarget assignmentId=\"b92d53be96e94b47bded399345236eb9\" role=\"Benefits Clerk\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Clerk - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n    <ProvisioningTarget assignmentId=\"e4ed87c2ad1f4f2cb13b35937ab1e78a\" role=\"Benefits Manager\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Clerk - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Benefits Manager - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n    <ProvisioningTarget assignmentId=\"ce66fb154b1e428eb72cd11a66a15164\" retain=\"true\" role=\"Payroll Analyst\">\n      <AccountSelection applicationId=\"c0a8019c81001480818100953c6c0362\" applicationName=\"Active_Directory\" roleName=\"Payroll General Access - IT\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n      <AccountSelection applicationId=\"c0a8019c81001480818100953e3e0373\" applicationName=\"Composite_ERP_Global_Platform\" selection=\"237\">\n        <AccountInfo displayName=\"AdamKennedy\" nativeIdentity=\"237\"/>\n      </AccountSelection>\n    </ProvisioningTarget>\n  </ProvisioningTargets>\n  <Requesters>\n    <Reference class=\"sailpoint.object.Identity\" id=\"c0a8019c8100148081810094e34d00ea\" name=\"spadmin\"/>\n  </Requesters>\n</ProvisioningPlan>\n","type":"application/xml"}]},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Endpoint used to launch a Workflow.","description":{"content":"Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched.","type":"text/plain"},"url":{"path":["LaunchedWorkflows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: iiq/api/identityiq-scim-rest-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Endpoint used to launch a Workflow.' (launch-workflow)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Endpoint used to launch a Workflow.



Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"attributes","schema":{"type":"string","example":"input"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"workflowName"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}}></ParamsItem></ul></div></details><MimeTabs schemaType={"request"}><TabItem label={"application/scim+json"} value={"application/scim+json"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"Schemas related to Launched Workflows."} schemaName={"undefined[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"workflowName"} required={false} deprecated={undefined} schemaDescription={"Name of the Workflow to launch."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>input</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of input attributes of the Launched Workflow.

</div><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"The attribute key."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The attribute value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The attribute type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"*/*"} value={"*/*"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"Schemas related to Launched Workflows."} schemaName={"undefined[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"workflowName"} required={false} deprecated={undefined} schemaDescription={"Name of the Workflow to launch."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>input</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of input attributes of the Launched Workflow.

</div><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"The attribute key."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The attribute value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The attribute type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"201"} value={"201"}><div>

Executes a workflow and returns the resulting LaunchedWorkflow. **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"targetName"} required={false} deprecated={undefined} schemaDescription={"Target name of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={false} deprecated={undefined} schemaDescription={"The verified date of the TaskResult."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"partitioned"} required={false} deprecated={undefined} schemaDescription={"Flag to indicate if the TaskResult is partitioned."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} deprecated={undefined} schemaDescription={"The completed date of the TaskResult."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Type of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={false} deprecated={undefined} schemaDescription={"The launched date of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"pendingSignOffs"} required={false} deprecated={undefined} schemaDescription={"Number of pending signoffs of this TaskResult."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

LaunchedWorkflow properties.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>output</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The output attribute type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The output attribute value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"The output attribute key."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"retries"} required={false} deprecated={undefined} schemaDescription={"The number of retries performed during the execution of provisioning activities."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>input</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"The input attribute key."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The input attribute value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The input attribute type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"workflowSummary"} required={false} deprecated={undefined} schemaDescription={"XML representation of the workflow summary."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"workflowName"} required={false} deprecated={undefined} schemaDescription={"Name of the workflow to launch."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityRequestId"} required={false} deprecated={undefined} schemaDescription={"Id representing the identity request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"workflowCaseId"} required={false} deprecated={undefined} schemaDescription={"Id representing the workflow case (a running instance of a workflow)."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"targetClass"} required={false} deprecated={undefined} schemaDescription={"Target class of the Task Result."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata for the LaunchedWorkflow TaskResult.

</div><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"Datetime when the TaskResult for the LaunchedWorkflow was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"URL to the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"Datetime of LaunchedWorkflow TaskResult last modification"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"Version of the LaunchedWorkflow TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"Resource type of the metadata subject"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"Schemas related to LaunchedWorkflow."} schemaName={"undefined[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the TaskResult for the Workflow launch."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={false} deprecated={undefined} schemaDescription={"List of messages of the TaskResult."} schemaName={"undefined[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of attributes of the TaskResult.

</div><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"The attribute key."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The attribute value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Id of the task result for the Workflow launch."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} deprecated={undefined} schemaDescription={"Completion Status of the TaskResult."} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"taskDefinition"} required={false} deprecated={undefined} schemaDescription={"Name of the TaskDefinition of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"terminated"} required={false} deprecated={undefined} schemaDescription={"Flag to indicate this TaskResult is terminated."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={false} deprecated={undefined} schemaDescription={"Launcher of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"targetName\": \"Ernest.Wagner\",\n  \"verified\": \"2022-05-26T11:17:13.481-05:00\",\n  \"partitioned\": false,\n  \"completed\": \"2022-05-26T11:17:13.678-05:00\",\n  \"type\": \"LCM\",\n  \"launched\": \"string\",\n  \"pendingSignOffs\": 0,\n  \"urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow\": {\n    \"output\": [\n      {\n        \"type\": \"application/int\",\n        \"value\": \"0\",\n        \"key\": \"workflowSummary\"\n      }\n    ],\n    \"retries\": 0,\n    \"input\": [\n      {\n        \"key\": \"optimisticProvisioning\",\n        \"value\": \"true\",\n        \"type\": \"boolean\"\n      }\n    ],\n    \"workflowSummary\": \"<WorkflowSummary step=\\\"end\\\"/>\\n\",\n    \"workflowName\": \"LCM Manage Passwords.\",\n    \"identityRequestId\": \"0000000004\",\n    \"workflowCaseId\": \"c0a8019c810011478181012862b81568\"\n  },\n  \"targetClass\": \"Identity\",\n  \"meta\": [\n    {\n      \"created\": \"2022-03-31T14:52:40.245-05:00\",\n      \"location\": \"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c810011478181012862b51567\",\n      \"lastModified\": \"2022-03-31T14:52:40.265-05:00\",\n      \"version\": \"\\\"W\\\"1649951092552\\\"\",\n      \"resourceType\": \"LaunchedWorkflow\"\n    }\n  ],\n  \"schemas\": [\n    [\n      \"urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow\",\n      \"urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult\"\n    ]\n  ],\n  \"name\": \"LCM Manage Passwords - 2\",\n  \"messages\": [\n    [\n      \"Connection error\"\n    ]\n  ],\n  \"Attributes\": {\n    \"key\": \"retries\",\n    \"value\": \"0\"\n  },\n  \"id\": \"c0a8019c810011478181012862b51567\",\n  \"completionStatus\": \"Success\",\n  \"taskDefinition\": \"Workflow Launcher\",\n  \"terminated\": false,\n  \"launcher\": \"spadmin\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>