Skip to content

Commit f6f7422

Browse files
authored
Merge pull request #211368 from MicrosoftDocs/main
Merge main to live, 4 AM
2 parents 13c3e90 + e210abd commit f6f7422

File tree

147 files changed

+16477
-15339
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+16477
-15339
lines changed

.openpublishing.redirection.azure-monitor.json

Lines changed: 4920 additions & 0 deletions
Large diffs are not rendered by default.

.openpublishing.redirection.json

Lines changed: 9258 additions & 14177 deletions
Large diffs are not rendered by default.

articles/active-directory/governance/check-status-workflow.md

Lines changed: 6 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -69,90 +69,31 @@ To get further information than just the runs summary for a workflow, you're als
6969

7070
To view a status list of users processed by a workflow, which are UserProcessingResults, you'd make the following API call:
7171

72-
```http
73-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults
74-
```
75-
76-
By default **userProcessingResults** returns only information from the last 7 days. To get information as far back as 30 days, you would run the following API call:
77-
78-
```http
79-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults?$filter=<Date range for processing results>
80-
```
81-
82-
by default **userProcessingResults** returns only information from the last 7 days. To filter information as far back as 30 days, you would run the following API call:
83-
84-
```http
85-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<id>/userProcessingResults?$filter=<Date range for processing results>
86-
```
87-
88-
An example of a call to get **userProcessingResults** for a month would be as follows:
89-
90-
```http
91-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults?$filter=< startedDateTime ge 2022-05-23T00:00:00Z and startedDateTime le 2022-06-22T00:00:00Z
92-
```
72+
To view a list of user processing results using API via Microsoft Graph, see: [List userProcessingResults](/graph/api/identitygovernance-workflow-list-userprocessingresults)
9373

9474
### User processing results using Microsoft Graph
9575

96-
When multiple user events are processed by a workflow, running the **userProcessingResults** may give incomprehensible information. To get a summary of information such as total users and tasks, and failed users and tasks, Lifecycle Workflows provides a call to get count totals.
97-
98-
To view a summary in count form, you would run the following API call:
99-
```http
100-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/summary(<Date Range>)
101-
```
102-
103-
An example to get the summary between May 1, and May 30, you would run the following call:
76+
To view a summary of user processing results via API using Microsoft Graph, see: [userProcessingResult: summary](/graph/api/identitygovernance-userprocessingresult-summary)
10477

105-
```http
106-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/summary(startDateTime=2022-05-01T00:00:00Z,endDateTime=2022-05-30T00:00:00Z)
107-
```
10878

109-
### List task processing results of a given user processing result
110-
111-
```http
112-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/<userProcessingResultId>/taskProcessingResults/
113-
```
11479

11580
## Run workflow history via Microsoft Graph
11681

11782
### List runs using Microsoft Graph
11883

119-
With Microsoft Graph, you're able to get full details of workflow and user processing run information.
120-
121-
To view a list of runs, you'd make the following API call:
84+
To view runs of a workflow via API using Microsoft Graph, see: [runs](/graph/api/resources/identitygovernance-run)
12285

123-
```http
124-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs
125-
```
12686

12787
### Get a summary of runs using Microsoft Graph
12888

129-
To get a summary of runs for a workflow, which includes detailed information for counts of failed runs and tasks, along with successful runs and tasks for a time range, you'd make the following API call:
130-
131-
```http
132-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/summary(startDateTime=<time>,endDateTime=<time>)
133-
```
134-
An example to get a summary of runs of a workflow through the time interval of May 2022 would be as follows:
135-
136-
```http
137-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/summary(startDateTime=2022-05-01T00:00:00Z,endDateTime=202205-31T00:00:00Z)
138-
```
89+
To view run summary via API using Microsoft Graph, see: [run summary of a lifecycle workflow](/graph/api/identitygovernance-run-summary)
13990

14091
### List user and task processing results of a given run using Microsoft Graph
14192

142-
With Lifecycle Workflows, you're able to check the status of each user and task who had a workflow processed for them as part of a run.
143-
144-
145-
You're also able to use **userProcessingResults** with the run call to get users processed for a run by making the following API call:
146-
147-
```http
148-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/<runId>/userProcessingResults
149-
```
93+
To get user processing result for a run of a lifecycle workflow via API using Microsoft Graph, see: [Get userProcessingResult (for a run of a lifecycle workflow)](/graph/api/identitygovernance-userprocessingresult-get)
15094

151-
This API call will also return a **userProcessingResults ID** value, which can be used to retrieve task processing information in the following call:
95+
To list task processing results for a user processing result via API using Microsoft Graph, see: [List taskProcessingResults (for a userProcessingResult)](/graph/api/identitygovernance-userprocessingresult-list-taskprocessingresults)
15296

153-
```http
154-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId> /runs/<runId>/userProcessingResults/<userProcessingResultId>/taskProcessingResults
155-
```
15697

15798
> [!NOTE]
15899
> A workflow must have activity in the past 7 days to get **userProcessingResults ID**. If there has not been any activity in that time-frame, the **userProcessingResults** call will not return a value.

articles/active-directory/governance/create-lifecycle-workflow.md

Lines changed: 1 addition & 226 deletions
Original file line numberDiff line numberDiff line change
@@ -64,234 +64,9 @@ If you are using the Azure portal to create a workflow, you can customize existi
6464
6565
## Create a workflow using Microsoft Graph
6666

67-
Workflows can be created using Microsoft Graph API. Creating a workflow using the Graph API allows you to automatically set it to enabled. Setting it to enabled is done using the `isEnabled` parameter.
68-
69-
The table below shows the parameters that must be defined during workflow creation:
70-
71-
|Parameter |Description |
72-
|---------|---------|
73-
|category | A string that identifies the category of the workflow. String is "joiner", "mover", or "leaver. Category of tasks within a workflow must also contain the category of the workflow to run. For full task definitions, see: [Lifecycle workflow tasks and definitions](lifecycle-workflow-tasks.md) |
74-
|displayName | A unique string that identifies the workflow. |
75-
|description | A string that describes the purpose of the workflow for administrative use. (Optional) |
76-
|isEnabled | A boolean value that denotes whether the workflow is set to run or not. If set to “true" then the workflow will run. |
77-
|IsSchedulingEnabled | A Boolean value that denotes whether scheduling is enabled or not. Unlike isEnbaled, a workflow can still be run on demand if this value is set to false. |
78-
|executionConditions | An argument that contains: A time-based attribute and an integer parameter defining when a workflow will run between -60 and a scope attribute defining who the workflow runs for. |
79-
|tasks | An argument in a workflow that has a unique displayName and a description. It defines the specific tasks to be executed in the workflow. The specified task is outlined by the taskDefinitionID and its parameters. For a list of supported tasks, and their corresponding IDs, see [Lifecycle Workflow tasks and definitions](lifecycle-workflow-tasks.md). |
80-
81-
82-
83-
84-
To create a joiner workflow, in Microsoft Graph, use the following request and body:
85-
```http
86-
POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows
87-
Content-type: application/json
88-
```
89-
90-
```Request body
91-
{
92-
"category": "joiner",
93-
"displayName": "<Unique workflow name string>",
94-
"description": "<Unique workflow description>",
95-
"isEnabled":true,
96-
"tasks":[
97-
{
98-
"category": "joiner",
99-
"isEnabled": true,
100-
"taskTemplateId": "<Unique Task template>",
101-
"displayName": "<Unique task name>",
102-
"description": "<Task template description>",
103-
"arguments": "<task arguments>"
104-
}
105-
],
106-
"executionConditions": {
107-
"@odata.type" : "microsoft.graph.identityGovernance.scopeAndTriggerBasedCondition",
108-
"trigger": {
109-
"@odata.type" : "microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
110-
"timeBasedAttribute":"<time-based trigger argument>",
111-
"arguments": -7
112-
},
113-
"scope": {
114-
"@odata.type" : "microsoft.graph.identityGovernance.ruleBasedScope",
115-
"rule": "employeeType eq '<Employee type attribute>' AND department -eq '<department attribute>'"
116-
}
117-
}
118-
}
119-
120-
> [!NOTE]
121-
> time based trigger arguments can be from -60 to 60. The negative value denotes **Before** a time based argument, while a positive value denotes **After**. For example the -7 in the workflow example above denotes the workflow will run 1 week before the time-based argument happens.
122-
123-
```
124-
125-
To change this workflow from joiner to leaver, replace the category parameters to "leaver". To get a list of the task definitions that can be added to your workflow run the following call:
126-
127-
```http
128-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions
129-
```
130-
131-
The response to the code will look like:
132-
133-
```Response body
134-
{
135-
"@odata.context": "https://graph.microsoft-ppe.com/testppebetalcwpp4/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",
136-
"@odata.count": 13,
137-
"value": [
138-
{
139-
"category": "joiner,leaver",
140-
"description": "Add user to a group",
141-
"displayName": "Add User To Group",
142-
"id": "22085229-5809-45e8-97fd-270d28d66910",
143-
"version": 1,
144-
"parameters": [
145-
{
146-
"name": "groupID",
147-
"values": [],
148-
"valueType": "string"
149-
}
150-
]
151-
},
152-
{
153-
"category": "joiner,leaver",
154-
"description": "Disable user account in the directory",
155-
"displayName": "Disable User Account",
156-
"id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
157-
"version": 1,
158-
"parameters": []
159-
},
160-
{
161-
"category": "joiner,leaver",
162-
"description": "Enable user account in the directory",
163-
"displayName": "Enable User Account",
164-
"id": "6fc52c9d-398b-4305-9763-15f42c1676fc",
165-
"version": 1,
166-
"parameters": []
167-
},
168-
{
169-
"category": "joiner,leaver",
170-
"description": "Run a custom task extension",
171-
"displayName": "run a Custom Task Extension",
172-
"id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
173-
"version": 1,
174-
"parameters":
175-
{
176-
"name": "customtaskextensionID",
177-
"values": [],
178-
"valueType": "string"
179-
}
180-
]
181-
},
182-
{
183-
"category": "joiner,leaver",
184-
"description": "Remove user from membership of selected Azure AD groups",
185-
"displayName": "Remove user from selected groups",
186-
"id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
187-
"version": 1,
188-
"parameters": [
189-
{
190-
"name": "groupID",
191-
"values": [],
192-
"valueType": "string"
193-
}
194-
]
195-
},
196-
{
197-
"category": "joiner",
198-
"description": "Generate Temporary Access Password and send via email to user's manager",
199-
"displayName": "Generate TAP And Send Email",
200-
"id": "1b555e50-7f65-41d5-b514-5894a026d10d",
201-
"version": 1,
202-
"parameters": [
203-
{
204-
"name": "tapLifetimeMinutes",
205-
"values": [],
206-
"valueType": "string"
207-
},
208-
{
209-
"name": "tapIsUsableOnce",
210-
"values": [
211-
"true",
212-
"false"
213-
],
214-
"valueType": "enum"
215-
}
216-
]
217-
},
218-
{
219-
"category": "joiner",
220-
"description": "Send welcome email to new hire",
221-
"displayName": "Send Welcome Email",
222-
"id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
223-
"version": 1,
224-
"parameters": []
225-
},
226-
{
227-
"category": "joiner,leaver",
228-
"description": "Add user to a team",
229-
"displayName": "Add User To Team",
230-
"id": "e440ed8d-25a1-4618-84ce-091ed5be5594",
231-
"version": 1,
232-
"parameters": [
233-
{
234-
"name": "teamID",
235-
"values": [],
236-
"valueType": "string"
237-
}
238-
]
239-
},
240-
{
241-
"category": "leaver",
242-
"description": "Delete user account in Azure AD",
243-
"displayName": "Delete User Account",
244-
"id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",
245-
"version": 1,
246-
"parameters": []
247-
},
248-
{
249-
"category": "joiner,leaver",
250-
"description": "Remove user from membership of selected Teams",
251-
"displayName": "Remove user from selected Teams",
252-
"id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
253-
"version": 1,
254-
"parameters": [
255-
{
256-
"name": "teamID",
257-
"values": [],
258-
"valueType": "string"
259-
}
260-
]
261-
},
262-
{
263-
"category": "leaver",
264-
"description": "Remove user from all Azure AD groups memberships",
265-
"displayName": "Remove user from all groups",
266-
"id": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
267-
"version": 1,
268-
"parameters": []
269-
},
270-
{
271-
"category": "leaver",
272-
"description": "Remove user from all Teams memberships",
273-
"displayName": "Remove user from all Teams",
274-
"id": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
275-
"version": 1,
276-
"parameters": []
277-
},
278-
{
279-
"category": "leaver",
280-
"description": "Remove all licenses assigned to the user",
281-
"displayName": "Remove all licenses for user",
282-
"id": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",
283-
"version": 1,
284-
"parameters": []
285-
}
286-
]
287-
}
288-
289-
```
290-
For further details on task definitions and their parameters, see [Lifecycle Workflow Tasks](lifecycle-workflow-tasks.md).
291-
67+
To create a workflow using Microsoft Graph API, see [Create workflow (lifecycle workflow)](/graph/api/identitygovernance-lifecycleworkflowscontainer-post-workflows)
29268

29369
## Next steps
29470

295-
- [Create workflow (lifecycle workflow)](/graph/api/identitygovernance-lifecycleworkflowscontainer-post-workflows?view=graph-rest-beta)
29671
- [Manage a workflow's properties](manage-workflow-properties.md)
29772
- [Manage Workflow Versions](manage-workflow-tasks.md)

articles/active-directory/governance/delete-lifecycle-workflow.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,35 +58,32 @@ After deleting workflows, you can view them on the **Deleted Workflows (Preview)
5858

5959

6060
## Delete a workflow using Microsoft Graph
61-
You're also able to delete, view deleted, and restore deleted Lifecycle workflows using Microsoft Graph.
61+
62+
To delete a workflow using API via Microsoft Graph, see: [Delete workflow (lifecycle workflow)](/graph/api/identitygovernance-workflow-delete?view=graph-rest-beta).
63+
64+
65+
To view
6266

6367
Workflows can be deleted by running the following call:
6468
```http
6569
DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<id>
6670
```
6771
## View deleted workflows using Microsoft Graph
68-
You can view a list of deleted workflows by running the following call:
69-
```http
70-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows
71-
```
72+
73+
To View a list of deleted workflows using API via Microsoft Graph, see: [List deleted workflows](/graph/api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems).
74+
7275

7376
## Permanently delete a workflow using Microsoft Graph
74-
Deleted workflows can be permanently deleted by running the following call:
75-
```http
76-
DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/<id>
77-
```
77+
78+
To permanently delete a workflow using API via Microsoft Graph, see: [Permanently delete a deleted workflow](/graph/api/identitygovernance-deleteditemcontainer-delete)
7879

7980
## Restore deleted workflows using Microsoft Graph
8081

81-
Deleted workflows are available to be restored for 30 days before they're permanently deleted. To restore a deleted workflow, run the following API call:
82-
```http
83-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/<id>/restore
84-
```
82+
To restore a deleted workflow using API via Microsoft Graph, see: [Restore a deleted workflow](/graph/api/identitygovernance-workflow-restore)
8583
> [!NOTE]
8684
> Permanently deleted workflows are not able to be restored.
8785
8886
## Next steps
8987

90-
- [Delete workflow (lifecycle workflow)](/graph/api/identitygovernance-workflow-delete?view=graph-rest-beta)
9188
- [What are Lifecycle Workflows?](what-are-lifecycle-workflows.md)
9289
- [Manage Lifecycle Workflow Versions](manage-workflow-tasks.md)

0 commit comments

Comments
 (0)