workflow: previewWorkflow

Espacio de nombres: microsoft.graph.identityGovernance

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Ejecute un flujo de trabajo en modo de vista previa para los objetos de directorio seleccionados sin afectar a los usuarios de producción. Esta acción desencadena el procesamiento del flujo de trabajo en modo de vista previa y los resultados se pueden recuperar mediante la operación List userProcessingResults con $filter=workflowExecutionType eq 'previewMode'.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

Importante

Para el acceso delegado mediante cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado que conceda los permisos necesarios para esta operación. Administrador de flujos de trabajo de ciclo de vida es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON de los parámetros.

En la tabla siguiente se muestran los parámetros necesarios con esta acción.

Parámetro Tipo Description
temas Colección directoryObject Colección de objetos de directorio (normalmente usuarios) que se van a incluir en la ejecución en versión preliminar. Máximo de 10 sujetos por solicitud. Obligatorio.

Respuesta

Si se ejecuta correctamente, esta acción devuelve un código de respuesta 204 No Content.

Para recuperar los resultados de la ejecución en versión preliminar, use la operación List userProcessingResults con $filter=workflowExecutionType eq 'previewMode'. Es posible que los resultados no estén disponibles inmediatamente; el tiempo depende de la complejidad del flujo de trabajo. Los resultados pueden incluir usuarios de ejecuciones en versión preliminar anteriores para el mismo flujo de trabajo.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
    }
  ]
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content