workflow : préversionWorkflow

Espace de noms : microsoft.graph.identityGovernance

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Exécutez un workflow en mode préversion pour les objets d’annuaire sélectionnés sans affecter les utilisateurs de production. Cette action déclenche le traitement du flux de travail en mode préversion, et les résultats peuvent être récupérés à l’aide de l’opération List userProcessingResults avec $filter=workflowExecutionType eq 'previewMode'.

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-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle de Microsoft Entra pris en charge ou un rôle personnalisé qui accorde les autorisations requises pour cette opération. L’administrateur des workflows de cycle de vie est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/previewWorkflow

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant présente les paramètres requis pour cette action.

Paramètre Type Description
Sujets collection directoryObject Collection d’objets d’annuaire (généralement des utilisateurs) à inclure dans l’exécution de la préversion. Maximum de 10 sujets par demande. Obligatoire.

Réponse

Si elle réussit, cette action renvoie un code de réponse 204 No Content.

Pour récupérer les résultats de l’exécution de la préversion, utilisez l’opération List userProcessingResults avec $filter=workflowExecutionType eq 'previewMode'. Les résultats peuvent ne pas être immédiatement disponibles ; le minutage dépend de la complexité du flux de travail. Les résultats peuvent inclure des utilisateurs d’exécutions de préversion précédentes pour le même workflow.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/previewWorkflow
Content-Type: application/json

{
  "subjects": [
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "b59552b8-fa7b-4f68-8496-0a529aace8c0"
    },
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content