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
| 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"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernancePreviewWorkflow;
using Microsoft.Graph.Beta.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);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphidentitygovernance "github.com/microsoftgraph/msgraph-beta-sdk-go/identitygovernance"
graphmodels "github.com/microsoftgraph/msgraph-beta-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)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancepreviewworkflow.PreviewWorkflowPostRequestBody previewWorkflowPostRequestBody = new com.microsoft.graph.beta.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);
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')
.version('beta')
.post(previewWorkflow);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernancePreviewWorkflow\PreviewWorkflowPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\DirectoryObject;
use Microsoft\Graph\Beta\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();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.identitygovernance.lifecycleworkflows.workflows.item.microsoft_graph_identity_governance_preview_workflow.preview_workflow_post_request_body import PreviewWorkflowPostRequestBody
from msgraph_beta.generated.models.directory_object import DirectoryObject
from msgraph_beta.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)
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 204 No Content