Visão geral das APIs de fluxos de trabalho do ciclo de vida

  • Artigo

Fluxos de trabalho do ciclo de vida é um serviço de Governança de Identidade em Microsoft Entra ID que permite que as organizações automatizem processos básicos de ciclo de vida para seus usuários em três níveis:

  1. Marceador: quando um indivíduo entra no escopo de precisar de acesso; por exemplo, um novo funcionário entrando em uma empresa ou organização.
  2. Mover: quando um indivíduo se move entre limites dentro de uma organização; por exemplo, um usuário que estava no marketing agora é membro da organização de vendas. Esse movimento pode exigir mais acesso ou autorização ou revogação de outros privilégios.
  3. Leaver: quando um indivíduo deixa o escopo de precisar de acesso, o acesso pode precisar ser revogado e o usuário desprovisionado. Por exemplo, um funcionário que está se aposentando ou encerrado.

Por esse motivo, os fluxos de trabalho do ciclo de vida podem ser chamados de fluxo de trabalho JML (Joiner-Mover-Leaver ).

As APIs de fluxo de trabalho do ciclo de vida no Microsoft Graph permitem automatizar os recursos de fluxos de trabalho do ciclo de vida para sua organização. Este artigo introduziu o conjunto de APIs que habilitam o serviço de fluxos de trabalho do ciclo de vida em Microsoft Entra ID.

As APIs de fluxos de trabalho do ciclo de vida são definidas no subnamespace OData, microsoft.graph.identityGovernance.

Observação

Este artigo descreve como exportar dados pessoais de um dispositivo ou serviço. Essas etapas podem ser usadas para dar suporte às suas obrigações de acordo com o GDPR (Regulamento Geral de Proteção de Dados). Os administradores de locatários autorizados podem usar o Microsoft Graph para corrigir, atualizar ou excluir informações identificáveis sobre usuários finais, incluindo perfis de usuário de clientes e funcionários ou dados pessoais, como nome do usuário, título de trabalho, endereço ou número de telefone, em seu ambiente Microsoft Entra ID.

Fluxos de trabalho

Os fluxos de trabalho são contêineres para os processos envolvidos no gerenciamento do ciclo de vida dos usuários na organização. Em sua essência estão tarefas e condições de execução.

  • As tarefas são ações específicas que são executadas automaticamente quando um fluxo de trabalho é disparado.
  • As condições de execução definem o escopo de "quem" e o gatilho de "quando" um fluxo de trabalho é executado.

Para criar fluxos de trabalho, recomendamos usar um dos modelos de fluxo de trabalho predefinidos.

Modelos de fluxos de trabalho

Microsoft Entra ID fornece os seguintes modelos de fluxo de trabalho predefinidos que definem os modelos para combinações de tarefas e condições de execução que podem fazer parte de um fluxo de trabalho. Você pode usar os modelos de fluxo de trabalho para criar seus fluxos de trabalho de forma programática.

Tipo de modelo de fluxo de trabalho Categoria ciclo de vida
Integrar o funcionário de pré-contratação Joiner
Integrar novo funcionário contratado Joiner
Pós-Integração de novo funcionário contratado Joiner
Alteração de funcionário em tempo real Mover
Rescisão de funcionário em tempo real Leaver
Pré-offboard de um funcionário Leaver
Desativar um funcionário Leaver
Pós-offboard de um funcionário Leaver

Use o tipo de recurso workflowTemplate e seus métodos associados para identificar os modelos pré-configurados e as tarefas e as condições de execução que eles dão suporte e copiar e usar os modelos para criar seus fluxos de trabalho de forma programática.

Informações gerais do fluxo de trabalho

Cada fluxo de trabalho contém informações descritivas gerais, como seu identificador, nome, descrição e se ele está habilitado para ser executado como agendado ou sob demanda.

Tarefas de fluxo de trabalho

As tarefas de fluxo de trabalho são ações específicas que são executadas automaticamente quando um fluxo de trabalho é disparado. Os fluxos de trabalho do ciclo de vida definem as seguintes tarefas pré-configuradas e somente leitura permitidas para as categorias de fluxo de trabalho especificadas. Essas definições de tarefa mostram as configurações para o tipo de tarefa, orientando você à medida que você cria tarefas para o fluxo de trabalho.

Atualmente, os fluxos de trabalho do ciclo de vida dão suporte às seguintes tarefas:

Tarefa taskdefinitionID Categoria
Enviar email de boas-vindas para nova contratação 70b29d51-b59a-4773-9280-8841dfd3f2ea Joiner
Enviar email de lembrete de integração 3C860712-2D37-42A4-928F-5C93935D26A1 Joiner
Gerar o Passe de Acesso Temporário e enviar por email para o gerenciador do usuário 1b555e50-7f65-41d5-b514-5894a026d10d Joiner
Solicitar atribuição de pacote de acesso do usuário c1ec1e76-f374-4375-aaa6-0bb6bd4c60be Marceador, Mover
Enviar email para notificar o gerente de movimentação de usuário aab41899-9972-422a-9d97-f626014578b7 Mover
Adicionar usuário a grupos 22085229-5809-45e8-97fd-270d28d66910 Marceador, Leaver, Mover
Adicionar usuário às equipes e440ed8d-25a1-4618-84ce-091ed5be5594 Marceador, Leaver, Mover
Ativar conta de usuário 6fc52c9d-398b-4305-9763-15f42c1676fc Marceiro, Leaver
Executar uma extensão de tarefa personalizada 4262b724-8dba-4fad-afc3-43fcbb497a0e Marceador, Leaver, Mover
Desabilitar conta de usuário 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 Leaver
Remover o usuário do grupo selecionado 1953a66c-751c-45e5-8bfe-01462c70da3c Marceador, Leaver, Mover
Remover usuários de todos os grupos b3a31406-2a15-4c9a-b25b-a658fa5f07fc Leaver
Remover usuário das equipes 06aa7acb-01af-4824-8899-b14e5ed788d6 Marceador, Leaver, Mover
Remover usuário de todas as equipes 81f7b200-2816-4b3b-8c5d-dc556f07b024 Leaver
Remover todas as atribuições de licença do usuário 8fa97d28-3e52-4985-b3a9-a1126f9b8b4e Leaver
Remover a atribuição do pacote de acesso para o usuário 4a0b64f2-c7ec-46ba-b117-18f262946c50 Leaver, Mover
Remover todas as atribuições de pacote de acesso para o usuário 42ae2956-193d-4f39-be06-691b8ac4fa1d Leaver
Cancelar todas as solicitações de atribuição de pacote de acesso pendentes para o usuário 498770d9-bab7-4e4c-b73d-5ded82a1d0b3 Leaver
Excluir usuário 8d18588d-9ad3-4c0f-99d0-ec215f0e3dff Leaver
Enviar email para o gerenciador antes do usuário no último dia 52853a3e-f4e5-4eb8-bb24-1ac09a1da935 Leaver
Enviar email aos usuários no último dia 9c0a1eaf-5bda-4392-9d9e-6e155bb57411 Leaver
Enviar email de offboard para o gerenciador de usuários após seu último dia 6f22ddd4-b3a5-47a4-a846-0d7c201a49ce Leaver

Use o tipo de recurso taskDefinition e seus métodos associados para descobrir todas as tarefas predefinidas que podem ser configuradas para o fluxo de trabalho e as configurações para as propriedades. O tipo de recurso de tarefa e seus métodos GET associados permitem exibir as tarefas configuradas para o fluxo de trabalho.

Condições de execução

Para cada tarefa de fluxo de trabalho, há uma condição de execução que define o escopo de "quem" e o gatilho de "quando" um fluxo de trabalho e suas tarefas associadas são executados. Por exemplo, uma condição de execução pode especificar que um fluxo de trabalho é executado para funcionários que saem, sete dias antes da data de término do emprego, se eles estiverem no departamento de R&D. A tarefa associada no fluxo de trabalho pode especificar que o usuário é removido das equipes e grupos do R&D.

⁄⁄Sample snippet for the executionConditions object

"executionConditions": {
    "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
    "scope": {
        "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
        "rule": "department eq 'R&D'"
    },
    "trigger": {
        "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
        "timeBasedAttribute": "employeeLeaveDateTime",
        "offsetInDays": -7
    }
}

Ao criar ou atualizar um fluxo de trabalho, use o tipo de recurso workflowExecutionConditions para configurar as condições de execução. Use esse objeto para configurar também um fluxo de trabalho que é executado somente sob demanda.

Criar e gerenciar fluxos de trabalho

Depois de identificar as tarefas e as condições de execução que você deseja definir para o fluxo de trabalho, use o tipo de recurso de fluxo de trabalho e seus métodos associados para criar e gerenciar o fluxo de trabalho. Você pode criar até 100 fluxos de trabalho em um locatário. A categoria da tarefa deve corresponder à categoria do fluxo de trabalho. Cada fluxo de trabalho pode ter até 25 tarefas. Portanto:

  • Uma tarefa com suporte apenas para a categoria de fluxo de trabalho "leaver" não pode ser especificada em um cenário de fluxo de trabalho "joiner" ou "mover" e vice-versa.
  • Uma tarefa com suporte para categorias de fluxo de trabalho "joiner", "mover" e "leaver" pode ser especificada em um cenário de fluxo de trabalho "joiner", "mover" ou "leaver".

Você pode agendar um fluxo de trabalho para ser executado com base na agenda de todo o locatário ou executá-lo sob demanda. A agenda de locatários pode cuidar de novas contratações e terminações agendadas, enquanto você pode executar um fluxo de trabalho sob demanda imediatamente para encerrar o acesso de um funcionário se houver um evento confidencial.

Versões do fluxo de trabalho

Enquanto um fluxo de trabalho está em uso, talvez seja necessário atualizar condições de execução e tarefas para um fluxo de trabalho. No entanto, os fluxos de trabalho do ciclo de vida não permitem que você atualize essas propriedades para um fluxo de trabalho existente.

Em vez de criar novos fluxos de trabalho, use o tipo de recurso workflowVersion e seus métodos associados para criar e gerenciar uma nova versão de fluxo de trabalho, com base em um objeto de fluxo de trabalho existente. A versão do fluxo de trabalho pode ter um conjunto semelhante ou diferente de tarefas e condições de execução.

Relatórios

Os fluxos de trabalho do ciclo de vida dão suporte a amplos recursos de relatório para acompanhar o status do processamento do fluxo de trabalho no nível de execução do fluxo de trabalho, no nível da tarefa e no nível do usuário.

Para obter mais informações sobre os recursos de relatório para fluxos de trabalho do ciclo de vida, confira a visão geral das APIs de relatório de fluxos de trabalho do ciclo de vida.

Extensões

Às vezes, as tarefas internas podem não ser adequadas para atender a todos os seus cenários de negócios. Para estender seus cenários de gerenciamento do ciclo de vida, os fluxos de trabalho do ciclo de vida dão suporte à definição de tarefas personalizadas para integrar com sistemas externos por meio dos Aplicativos Lógicos do Azure. Por exemplo, para um cenário de "leaver", você também pode querer conceder ao gerenciador do usuário acesso à conta de email do usuário.

Use o tipo de recurso customTaskExtension e seus métodos associados para definir as configurações do aplicativo lógico do Azure.

Configurações

Cada locatário define uma agenda em todo o locatário quando todos os fluxos de trabalho agendados são executados. O locatário pode adotar o cronograma padrão definido Microsoft Entra ID em que os fluxos de trabalho são executados a cada três horas ou modificar o agendamento para ser executado entre 1 hora e 24 horas.

Verificações de licença

Usar esse recurso requer licenças de Microsoft Entra ID Governance. Para encontrar a licença certa para seus requisitos, consulte Comparar recursos geralmente disponíveis do Microsoft Microsoft Entra ID.

Verificações de autorização de função e de aplicativo

As funções de Microsoft Entra a seguir são necessárias para que um usuário chamado gerencie fluxos de trabalho do ciclo de vida.

Operação Permissões de aplicativos Função de diretório necessária do usuário de chamada
Leitura Ciclo de vidaWorkflows.Read.All ou LifecycleWorkflows.ReadWrite.All Administrador global de fluxos de trabalho do leitor ou ciclo de vida
Criar, Atualizar ou Excluir LifecycleWorkflows.ReadWrite.All Administrador de fluxos de trabalho do ciclo de vida

Conteúdo relacionado