Namespace: microsoft.graph.identityGovernance
Execute um fluxo de trabalho no modo de visualização para objetos de diretório selecionados sem afetar os usuários de produção. Essa ação dispara o processamento do fluxo de trabalho no modo de visualização, e os resultados podem ser recuperados usando a operação List userProcessingResults com $filter=workflowExecutionType eq 'previewMode'.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global |
Governo dos EUA L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
✅ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão |
Permissões menos privilegiadas |
Permissões com privilégios mais elevados |
| Delegado (conta corporativa ou de estudante) |
LifecycleWorkflows-Workflow.ReadWrite.All |
LifecycleWorkflows.ReadWrite.All |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
LifecycleWorkflows-Workflow.ReadWrite.All |
LifecycleWorkflows.ReadWrite.All |
Importante
Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte 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 com suporte para essa operação.
Solicitação HTTP
POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/previewWorkflow
| 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 da solicitação, forneça uma representação JSON dos parâmetros.
A tabela a seguir mostra os parâmetros necessários para essa ação.
| Parâmetro |
Tipo |
Descrição |
| assuntos |
Coleção directoryObject |
Uma coleção de objetos de diretório (normalmente usuários) a serem incluídos na execução de visualização. Máximo de 10 pessoas por solicitação. Obrigatório. |
Resposta
Se tiver êxito, esta ação retornará um código de resposta 204 No Content.
Para recuperar os resultados da execução de visualização, use a operação List userProcessingResults com $filter=workflowExecutionType eq 'preview'. Os resultados podem não estar disponíveis imediatamente; O tempo depende da complexidade do fluxo de trabalho. Os resultados podem incluir usuários de execuções de 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/v1.0/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"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernancePreviewWorkflow;
using Microsoft.Graph.Models;
var requestBody = new PreviewWorkflowPostRequestBody
{
Subjects = new List<DirectoryObject>
{
new User
{
OdataType = "#microsoft.graph.user",
Id = "b59552b8-fa7b-4f68-8496-0a529aace8c0",
},
new User
{
OdataType = "#microsoft.graph.user",
Id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.IdentityGovernance.LifecycleWorkflows.Workflows["{workflow-id}"].MicrosoftGraphIdentityGovernancePreviewWorkflow.PostAsync(requestBody);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/identitygovernance"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphidentitygovernance.NewPreviewWorkflowPostRequestBody()
directoryObject := graphmodels.NewUser()
id := "b59552b8-fa7b-4f68-8496-0a529aace8c0"
directoryObject.SetId(&id)
directoryObject1 := graphmodels.NewUser()
id := "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
directoryObject1.SetId(&id)
subjects := []graphmodels.DirectoryObjectable {
directoryObject,
directoryObject1,
}
requestBody.SetSubjects(subjects)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.IdentityGovernance().LifecycleWorkflows().Workflows().ByWorkflowId("workflow-id").MicrosoftGraphIdentityGovernancePreviewWorkflow().Post(context.Background(), requestBody, nil)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancepreviewworkflow.PreviewWorkflowPostRequestBody previewWorkflowPostRequestBody = new com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancepreviewworkflow.PreviewWorkflowPostRequestBody();
LinkedList<DirectoryObject> subjects = new LinkedList<DirectoryObject>();
User directoryObject = new User();
directoryObject.setOdataType("#microsoft.graph.user");
directoryObject.setId("b59552b8-fa7b-4f68-8496-0a529aace8c0");
subjects.add(directoryObject);
User directoryObject1 = new User();
directoryObject1.setOdataType("#microsoft.graph.user");
directoryObject1.setId("a1b2c3d4-e5f6-7890-abcd-ef1234567890");
subjects.add(directoryObject1);
previewWorkflowPostRequestBody.setSubjects(subjects);
graphClient.identityGovernance().lifecycleWorkflows().workflows().byWorkflowId("{workflow-id}").microsoftGraphIdentityGovernancePreviewWorkflow().post(previewWorkflowPostRequestBody);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
const options = {
authProvider,
};
const client = Client.init(options);
const previewWorkflow = {
subjects: [
{
'@odata.type': '#microsoft.graph.user',
id: 'b59552b8-fa7b-4f68-8496-0a529aace8c0'
},
{
'@odata.type': '#microsoft.graph.user',
id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
}
]
};
await client.api('/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/previewWorkflow')
.post(previewWorkflow);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernancePreviewWorkflow\PreviewWorkflowPostRequestBody;
use Microsoft\Graph\Generated\Models\DirectoryObject;
use Microsoft\Graph\Generated\Models\User;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PreviewWorkflowPostRequestBody();
$subjectsDirectoryObject1 = new User();
$subjectsDirectoryObject1->setOdataType('#microsoft.graph.user');
$subjectsDirectoryObject1->setId('b59552b8-fa7b-4f68-8496-0a529aace8c0');
$subjectsArray []= $subjectsDirectoryObject1;
$subjectsDirectoryObject2 = new User();
$subjectsDirectoryObject2->setOdataType('#microsoft.graph.user');
$subjectsDirectoryObject2->setId('a1b2c3d4-e5f6-7890-abcd-ef1234567890');
$subjectsArray []= $subjectsDirectoryObject2;
$requestBody->setSubjects($subjectsArray);
$graphServiceClient->identityGovernance()->lifecycleWorkflows()->workflows()->byWorkflowId('workflow-id')->microsoftGraphIdentityGovernancePreviewWorkflow()->post($requestBody)->wait();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Import-Module Microsoft.Graph.Identity.Governance
$params = @{
subjects = @(
@{
"@odata.type" = "#microsoft.graph.user"
id = "b59552b8-fa7b-4f68-8496-0a529aace8c0"
}
@{
"@odata.type" = "#microsoft.graph.user"
id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
)
}
Invoke-MgPreviewIdentityGovernanceLifecycleWorkflow -WorkflowId $workflowId -BodyParameter $params
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.identitygovernance.lifecycleworkflows.workflows.item.microsoft_graph_identity_governance_preview_workflow.preview_workflow_post_request_body import PreviewWorkflowPostRequestBody
from msgraph.generated.models.directory_object import DirectoryObject
from msgraph.generated.models.user import User
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PreviewWorkflowPostRequestBody(
subjects = [
User(
odata_type = "#microsoft.graph.user",
id = "b59552b8-fa7b-4f68-8496-0a529aace8c0",
),
User(
odata_type = "#microsoft.graph.user",
id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
),
],
)
await graph_client.identity_governance.lifecycle_workflows.workflows.by_workflow_id('workflow-id').microsoft_graph_identity_governance_preview_workflow.post(request_body)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 204 No Content