Partager via


Répertorier taskDefinitions

Espace de noms : microsoft.graph.identityGovernance

Obtenez la liste des tâches intégrées dans workflows de cycle de vie. Une tâche est représentée par l’objet taskDefinition .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) LifecycleWorkflows.CreateWorkflows LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application LifecycleWorkflows.CreateWorkflows LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Lecteur général et Administrateur de flux de travail de cycle de vie sont les rôles les moins privilégiés pris en charge pour cette opération.

Requête HTTP

GET /identityGovernance/lifecycleWorkflows/taskDefinitions

Paramètres facultatifs de la requête

Cette méthode prend en charge les $selectparamètres de requête OData , $orderbyet $filter pour vous aider à personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets microsoft.graph.identityGovernance.taskDefinition dans le corps de la réponse.

Exemples

Exemple 1 : Récupérer toutes les définitions de tâches intégrées

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/taskDefinitions

Réponse

L’exemple suivant illustre la réponse.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",
    "@odata.count": 24,
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identityGovernance/lifecycleWorkflows/taskDefinitions?$select=category,continueOnError",
    "value": [
        {
            "category": "joiner,leaver,mover",
            "description": "Add user to selected groups",
            "displayName": "Add user to groups",
            "id": "22085229-5809-45e8-97fd-270d28d66910",
            "version": 1,
            "parameters": [
                {
                    "name": "groupID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,leaver",
            "description": "Disable user account in the directory",
            "displayName": "Disable user account",
            "id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
            "version": 1,
            "parameters": [
                {
                    "name": "disableOnPremisesAccount",
                    "values": [
                        "true",
                        "false"
                    ],
                    "valueType": "enum"
                }
            ]
        },
        {
            "category": "joiner,leaver",
            "description": "Enable user account in the directory",
            "displayName": "Enable user account",
            "id": "6fc52c9d-398b-4305-9763-15f42c1676fc",
            "version": 1,
            "parameters": [
                {
                    "name": "enableOnPremisesAccount",
                    "values": [
                        "true",
                        "false"
                    ],
                    "valueType": "enum"
                }
            ]
        },
        {
            "category": "joiner,leaver,mover",
            "description": "Remove user from membership of selected Azure AD groups",
            "displayName": "Remove user from selected groups",
            "id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
            "version": 1,
            "parameters": [
                {
                    "name": "groupID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner",
            "description": "Generate Temporary Access Pass and send via email to user's manager",
            "displayName": "Generate TAP and send email",
            "id": "1b555e50-7f65-41d5-b514-5894a026d10d",
            "version": 1,
            "parameters": [
                {
                    "name": "tapLifetimeMinutes",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "tapIsUsableOnce",
                    "values": [
                        "true",
                        "false"
                    ],
                    "valueType": "enum"
                },
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner",
            "description": "Send welcome email to new hire",
            "displayName": "Send welcome email",
            "id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
            "version": 1,
            "parameters": [
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,leaver,mover",
            "description": "Add user to selected Teams",
            "displayName": "Add user to Teams",
            "id": "e440ed8d-25a1-4618-84ce-091ed5be5594",
            "version": 1,
            "parameters": [
                {
                    "name": "teamID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver",
            "description": "Delete user account in Azure AD",
            "displayName": "Delete user account",
            "id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",
            "version": 1,
            "parameters": [
                {
                    "name": "deleteOnPremisesAccount",
                    "values": [
                        "true",
                        "false"
                    ],
                    "valueType": "enum"
                }
            ]
        },
        {
            "category": "joiner,leaver,mover",
            "description": "Remove user from membership of selected Teams",
            "displayName": "Remove user from selected Teams",
            "id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
            "version": 1,
            "parameters": [
                {
                    "name": "teamID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver",
            "description": "Remove user from all Azure AD groups memberships",
            "displayName": "Remove user from all groups",
            "id": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
            "version": 1,
            "parameters": []
        },
        {
            "category": "leaver",
            "description": "Remove user from all Teams memberships",
            "displayName": "Remove user from all Teams",
            "id": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
            "version": 1,
            "parameters": []
        },
        {
            "category": "leaver",
            "description": "Remove all licenses assigned to the user",
            "displayName": "Remove all licenses for user",
            "id": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",
            "version": 1,
            "parameters": []
        },
        {
            "category": "joiner,leaver,mover",
            "description": "Run a Custom Task Extension to callout to an external system.",
            "displayName": "Run a Custom Task Extension",
            "id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
            "version": 1,
            "parameters": [
                {
                    "name": "customTaskExtensionID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver",
            "description": "Send offboarding email to user's manager before the last day of work",
            "displayName": "Send email before user's last day",
            "id": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935",
            "version": 1,
            "parameters": [
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver",
            "description": "Send offboarding email to user's manager on the last day of work",
            "displayName": "Send email on user's last day",
            "id": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411",
            "version": 1,
            "parameters": [
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver",
            "description": "Send offboarding email to user's manager after the last day of work",
            "displayName": "Send email after user's last day",
            "id": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce",
            "version": 1,
            "parameters": [
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner",
            "description": "Send onboarding reminder email to user's manager",
            "displayName": "Send onboarding reminder email",
            "id": "3C860712-2D37-42A4-928F-5C93935D26A1",
            "version": 1,
            "parameters": [
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,mover",
            "description": "Request user assignment to selected access package",
            "displayName": "Request user access package assignment",
            "id": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be",
            "version": 1,
            "parameters": [
                {
                    "name": "assignmentPolicyId",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "accessPackageId",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver,mover",
            "description": "Remove user assignment of selected access package",
            "displayName": "Remove access package assignment for user",
            "id": "4a0b64f2-c7ec-46ba-b117-18f262946c50",
            "version": 1,
            "parameters": [
                {
                    "name": "accessPackageId",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver",
            "description": "Remove all access packages assigned to the user",
            "displayName": "Remove all access package assignments for user",
            "id": "42ae2956-193d-4f39-be06-691b8ac4fa1d",
            "version": 1,
            "parameters": []
        },
        {
            "category": "leaver",
            "description": "Cancel all pending access packages assignment requests for the user",
            "displayName": "Cancel pending access package assignment requests for user",
            "id": "498770d9-bab7-4e4c-b73d-5ded82a1d0b3",
            "version": 1,
            "parameters": []
        },
        {
            "category": "mover",
            "description": "Send email to notify user's manager of user move",
            "displayName": "Send email to notify manager of user move",
            "id": "aab41899-9972-422a-9d97-f626014578b7",
            "version": 1,
            "parameters": [
                {
                    "name": "cc",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customSubject",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "customBody",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "locale",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,mover",
            "description": "Assign selected licenses to the user",
            "displayName": "Assign licenses to user",
            "id": "683c87a4-2ad4-420b-97d4-220d90afcd24",
            "version": 1,
            "parameters": [
                {
                    "name": "licenses",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "leaver,mover",
            "description": "Remove selected licenses assigned to the user",
            "displayName": "Remove licenses from user",
            "id": "5fc402a8-daaf-4b7b-9203-da868b05fc5f",
            "version": 1,
            "parameters": [
                {
                    "name": "licenses",
                    "values": [],
                    "valueType": "string"
                }
            ]
        }
    ]
}

Exemple 2 : Récupérer toutes les tâches intégrées prises en charge pour les workflows « joiner »

Demande

L’exemple suivant illustre une demande. Étant donné que la catégorie est une énumération marquée qui peut être , joinerjoiner,leaverou leaver, l’opérateur vérifie les has tâches où la catégorie inclut « joiner ».

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/taskDefinitions?$filter=category has 'joiner'

Réponse

L’exemple suivant illustre la réponse.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",
    "value": [
        {
            "category": "joiner,leaver",
            "description": "Add user to selected groups",
            "displayName": "Add User To Groups",
            "id": "22085229-5809-45e8-97fd-270d28d66910",
            "version": 1,
            "parameters": [
                {
                    "name": "groupID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,leaver",
            "description": "Disable user account in the directory",
            "displayName": "Disable User Account",
            "id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
            "version": 1,
            "parameters": []
        },
        {
            "category": "joiner,leaver",
            "description": "Enable user account in the directory",
            "displayName": "Enable User Account",
            "id": "6fc52c9d-398b-4305-9763-15f42c1676fc",
            "version": 1,
            "parameters": []
        },
        {
            "category": "joiner,leaver",
            "description": "Remove user from membership of selected Azure AD groups",
            "displayName": "Remove user from selected groups",
            "id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
            "version": 1,
            "parameters": [
                {
                    "name": "groupID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner",
            "description": "Generate Temporary Access Pass and send via email to user's manager",
            "displayName": "Generate TAP And Send Email",
            "id": "1b555e50-7f65-41d5-b514-5894a026d10d",
            "version": 1,
            "parameters": [
                {
                    "name": "tapLifetimeMinutes",
                    "values": [],
                    "valueType": "string"
                },
                {
                    "name": "tapIsUsableOnce",
                    "values": [
                        "true",
                        "false"
                    ],
                    "valueType": "enum"
                }
            ]
        },
        {
            "category": "joiner",
            "description": "Send welcome email to new hire",
            "displayName": "Send Welcome Email",
            "id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
            "version": 1,
            "parameters": []
        },
        {
            "category": "joiner,leaver",
            "description": "Add user to selected teams",
            "displayName": "Add User To Teams",
            "id": "e440ed8d-25a1-4618-84ce-091ed5be5594",
            "version": 1,
            "parameters": [
                {
                    "name": "teamID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,leaver",
            "description": "Remove user from membership of selected Teams",
            "displayName": "Remove user from selected Teams",
            "id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
            "version": 1,
            "parameters": [
                {
                    "name": "teamID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        },
        {
            "category": "joiner,leaver",
            "description": "Run a Custom Task Extension to callout to an external system.",
            "displayName": "Run a Custom Task Extension",
            "id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
            "version": 1,
            "parameters": [
                {
                    "name": "customTaskExtensionID",
                    "values": [],
                    "valueType": "string"
                }
            ]
        }
    ]
}