fluxo de trabalho: previewWorkflow

Espaço de nomes: microsoft.graph.identityGovernance

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Execute um fluxo de trabalho no modo de pré-visualização para objetos de diretório selecionados sem afetar os utilizadores de produção. Esta ação aciona o processamento do fluxo de trabalho no modo de pré-visualização e os resultados podem ser obtidos com a operação List userProcessingResults com $filter=workflowExecutionType eq 'previewMode'.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Ciclo de VidaWorkflows-Workflow.ReadWrite.All Ciclo de VidaWorkflows.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Ciclo de VidaWorkflows-Workflow.ReadWrite.All Ciclo de VidaWorkflows.ReadWrite.All

Importante

Para acesso delegado através de contas escolares ou profissionais, tem de ser atribuída ao utilizador com sessão iniciada uma função de Microsoft Entra suportada ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de Fluxos de Trabalho do Ciclo de Vida é a função com menos privilégios suportada para esta operação.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON dos parâmetros.

A tabela seguinte mostra os parâmetros necessários com esta ação.

Parâmetro Tipo Descrição
assuntos Coleção directoryObject Uma coleção de objetos de diretório (normalmente utilizadores) a incluir na execução de pré-visualização. Máximo de 10 requerentes por pedido. Obrigatório.

Resposta

Se tiver êxito, esta ação retornará um código de resposta 204 No Content.

Para obter os resultados da execução de pré-visualização, utilize a operação List userProcessingResults com $filter=workflowExecutionType eq 'previewMode'. Os resultados podem não estar imediatamente disponíveis; A temporização depende da complexidade do fluxo de trabalho. Os resultados podem incluir utilizadores de execuções de pré-visualização anteriores para o mesmo fluxo de trabalho.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content