Skip to content

identitygovernance-task-get.md

Latest commit

 

History

History
192 lines (147 loc) · 6.67 KB

identitygovernance-task-get.md

File metadata and controls

192 lines (147 loc) · 6.67 KB
title Get task
description Read the properties of a task object in a lifecycle workflow.
author AlexFilipin
ms.localizationpriority medium
ms.subservice entra-id-governance
doc_type apiPageType
ms.date 04/05/2024

Get task

Namespace: microsoft.graph.identityGovernance

[!INCLUDE beta-disclaimer]

Get a specific task from a workflow or workflowVersion.

[!INCLUDE national-cloud-support]

Permissions

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-read]

HTTP request

Fetch tasks for a lifecycle workflow.

GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/tasks/{taskId}

Fetch tasks for a lifecycle workflow version.

GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks/4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee

Optional query parameters

This method does not support OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a microsoft.graph.identityGovernance.task object in the response body.

Examples

Example 1: Get a task from a workflow

Request

The following example shows a request to get a task from a workflow.

GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflow/156ce798-1eb6-4e0a-8515-e79f54d04390/tasks/fafa2189-cd62-4643-a825-06cab8817086

Response

The following is an example of the response of a request to get a task from a workflow.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/tasks/$entity",
    "category": "joiner,leaver",
    "continueOnError": false,
    "description": "Enable user account in the directory",
    "displayName": "Enable User Account",
    "executionSequence": 1,
    "id": "fafa2189-cd62-4643-a825-06cab8817086",
    "isEnabled": true,
    "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
    "arguments": []
}

Example 2: Get a task from a workflow version

Request

The following example shows a request to get a task from a workflow version.

HTTP

GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks/4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following is an example of the response of a request to get a task from a workflow version.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/versions(1)/tasks/$entity",
  "category": "joiner,leaver",
  "continueOnError": false,
  "description": "Add user to selected groups",
  "displayName": "Add User To Groups",
  "executionSequence": 2,
  "id": "eedd8043-90a1-4e3c-9112-b2a8917ea3ae",
  "isEnabled": true,
  "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",
  "arguments": [
    {
      "name": "groupID",
      "value": "e5659cb0-bcbb-4a9f-9092-90f72bd19028"
    }
  ]
}