title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
Update workflow |
Update the properties of a workflow object. |
AlexFilipin |
medium |
entra-id-governance |
apiPageType |
Namespace: microsoft.graph.identityGovernance
Update the properties of a workflow object. Only the properties listed in the request body table can be updated. To update any other workflow properties, see workflow: createNewVersion.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
[!INCLUDE rbac-lifecycle-workflows-apis-write]
PATCH /identityGovernance/lifecycleWorkflows/workflows/{workflowId}
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
[!INCLUDE table-intro]
Property | Type | Description |
---|---|---|
description | String | Describes the purpose of the workflow for administrative use. |
displayName | String | A unique string that identifies the workflow. |
isEnabled | Boolean | A boolean value that denotes whether the workflow is set to run or not. |
isSchedulingEnabled | Boolean | A Boolean value that denotes whether scheduling is enabled or not. |
Note
You can also update task name and description within a workflow without creating a new version. For more information on these properties, see: update task.
If successful, this action returns a 204 No Content
response code.
The following example shows a request.
PATCH https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390
Content-Type: application/json
Content-length: 454
{
"description": "Configure new hire tasks for onboarding employees on their first day",
"displayName": "Australia Onboard new hire employee",
"isEnabled": true,
"isSchedulingEnabled": false
}
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
HTTP/1.1 204 No Content