Share via

Configurar os argumentos para tarefas internas do fluxo de trabalho do ciclo de vida

  • Artigo

A API de Fluxos de Trabalho do Ciclo de Vida no Microsoft Graph permite automatizar processos básicos de ciclo de vida para seus usuários em três níveis: Joiner, Leaver e Mover. O núcleo para os fluxos de trabalho são tarefas que representam as ações específicas que são executadas automaticamente quando um fluxo de trabalho é disparado.

O Microsoft Graph dá suporte a 24 tarefas internas que você pode usar para criar seus fluxos de trabalho personalizados. Cada tarefa tem um conjunto de argumentos permitidos para essa tarefa. Por exemplo, uma tarefa para gerar um TAP (passe de acesso temporário) para um usuário permite que você configure o tempo de vida do TAP e se o usuário pode reutilizá-lo. Uma tarefa para adicionar um usuário a um grupo exige que você especifique os grupos aos quais deseja adicionar o usuário. Essa configuração é feita na propriedade de argumentos de uma tarefa.

Este artigo fornece diretrizes sobre a configuração permitida para a propriedade arguments de tarefas em Fluxos de Trabalho do Ciclo de Vida.

Configurar argumentos para tarefas

Nome da exibição da tarefa taskDefinitionId Argumentos
Enviar email de boas-vindas para nova contratação 70b29d51-b59a-4773-9280-8841dfd3f2ea nome: cc
valor: uma ID de usuário válida (Cadeia de caracteres) para o usuário que você deseja cc no email.

nome: customSubject
valor: um cabeçalho de assunto personalizado para o email que está sendo enviado.


nome: customBody
valor: o corpo do email personalizado.


nome: locale
valor: valor de linguagem que substitui as configurações de linguagem do destinatário de email. Esse argumento não personaliza o texto personalizado do email e deve ser definido no mesmo idioma que o texto personalizado.
Enviar email de lembrete de integração 3C860712-2D37-42A4-928F-5C93935D26A1 nome: cc
valor: uma ID de usuário válida (Cadeia de caracteres) para o usuário que você deseja cc no email.

nome: customSubject
valor: um cabeçalho de assunto personalizado para o email que está sendo enviado.


nome: customBody
valor: o corpo do email personalizado.


nome: locale
valor: valor de linguagem que substitui as configurações de linguagem do destinatário de email. Esse argumento não personaliza o texto personalizado do email e deve ser definido no mesmo idioma que o texto personalizado.
Gerar o Passe de Acesso Temporário e enviar por email para o gerenciador do usuário 1b555e50-7f65-41d5-b514-5894a026d10d nome: tapLifetimeMinutes
valor: 10 upto 43000

nome: tapIsUsableOnce
valor: true ou false

Pré-requisitos:
  1. O usuário deve receber um gerente.
  2. O gerente do usuário deve ter o email habilitado.
  3. A política tap (passe de acesso temporário) deve ser habilitada no locatário e o usuário habilitado para usar o método de autenticação TAP. Para obter mais informações, consulte tipo de recurso temporaryAccessPassAuthenticationMethodConfiguration.
Adicionar usuário a grupos 22085229-5809-45e8-97fd-270d28d66910 nome: groupID
valor: uma ID de grupo válida ou uma lista separada por vírgulas de grupos aos quais o usuário é adicionado como membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Adicionar usuário às equipes e440ed8d-25a1-4618-84ce-091ed5be5594 nome: teamID
valor: uma ID de grupo válida ou uma lista separada por vírgulas de equipes à qual o usuário é adicionado como membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Ativar conta de usuário 6fc52c9d-398b-4305-9763-15f42c1676fc Nenhum
Executar uma extensão de tarefa personalizada 4262b724-8dba-4fad-afc3-43fcbb497a0e Nome: CustomTaskExtensionID
valor: A ID da extensão de tarefa personalizada
Atribuir licenças aos usuários (versão prévia) 683c87a4-2ad4-420b-97d4-220d90afcd24 Nome: licenses
valor: A ID da licença que você deseja atribuir
Remover atribuições de licença selecionadas do usuário (Versão prévia) 5fc402a8-daaf-4b7b-9203-da868b05fc5f Nome: licenses
valor: A ID da licença que você deseja atribuir
Executar uma extensão de tarefa personalizada 4262b724-8dba-4fad-afc3-43fcbb497a0e nome: CustomTaskExtensionID
valor: A ID da extensão de tarefa personalizada
Desabilitar conta de usuário 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 Nenhum
Remover o usuário do grupo selecionado 1953a66c-751c-45e5-8bfe-01462c70da3c nome: groupID
valor: uma ID de grupo válida ou uma lista separada por vírgulas de grupos dos quais o usuário é membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Remover usuários de todos os grupos b3a31406-2a15-4c9a-b25b-a658fa5f07fc Nenhum
Remover usuário das equipes 06aa7acb-01af-4824-8899-b14e5ed788d6 nome: teamID
valor: uma lista separada por vírgulas de equipes das quais o usuário é membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Remover usuário de todas as equipes 81f7b200-2816-4b3b-8c5d-dc556f07b024 Nenhum
Remover todas as atribuições de licença do usuário 8fa97d28-3e52-4985-b3a9-a1126f9b8b4e Nenhum
Excluir usuário 8d18588d-9ad3-4c0f-99d0-ec215f0e3dff Nenhum
Enviar email para notificar o gerente de movimentação de usuário aab41899-9972-422a-9d97-f626014578b7 nome: cc
valor: uma ID de usuário válida (Cadeia de caracteres) para o usuário que você deseja cc no email.

nome: customSubject
valor: um cabeçalho de assunto personalizado para o email que está sendo enviado.


nome: customBody
valor: o corpo do email personalizado.


nome: locale
valor: valor de linguagem que substitui as configurações de linguagem do destinatário de email. Não personaliza o texto personalizado do email e deve ser definido no mesmo idioma que o texto personalizado.
Enviar email para o gerenciador antes do usuário no último dia 52853a3e-f4e5-4eb8-bb24-1ac09a1da935 nome: cc
valor: uma ID de usuário válida (Cadeia de caracteres) para o usuário que você deseja cc no email.

nome: customSubject
valor: um cabeçalho de assunto personalizado para o email que está sendo enviado.


nome: customBody
valor: o corpo do email personalizado.


nome: locale
valor: valor de linguagem que substitui as configurações de linguagem do destinatário de email. Não personaliza o texto personalizado do email e deve ser definido no mesmo idioma que o texto personalizado.
Enviar email aos usuários no último dia 9c0a1eaf-5bda-4392-9d9e-6e155bb57411 nome: cc
valor: uma ID de usuário válida (Cadeia de caracteres) para o usuário que você deseja cc no email.

nome: customSubject
valor: um assunto personalizado para o email que está sendo enviado.


nome: customBody
valor: o corpo do email personalizado.


nome: locale
valor: valor de linguagem que substitui as configurações de linguagem do destinatário de email. Não personaliza o texto personalizado do email e deve ser definido no mesmo idioma que o texto personalizado.
Enviar email de offboard para o gerenciador de usuários após seu último dia 6f22ddd4-b3a5-47a4-a846-0d7c201a49ce nome: cc
valor: uma ID de usuário válida (Cadeia de caracteres) para o usuário que você deseja cc no email.

nome: customSubject
valor: um cabeçalho de assunto personalizado para o email que está sendo enviado.


nome: customBody
valor: o corpo do email personalizado.


nome: locale
valor: valor de linguagem que substitui as configurações de linguagem do destinatário de email. Não personaliza o texto personalizado do email e deve ser definido no mesmo idioma que o texto personalizado.
Solicitar atribuição de pacote de acesso do usuário c1ec1e76-f374-4375-aaa6-0bb6bd4c60be nome: assignmentPolicyId
valor: uma ID de política de atribuição válida (String) para o pacote de acesso que você deseja atribuir ao usuário.

nome: accessPackageId
valor: uma ID de pacote de acesso válida para o pacote de acesso que você deseja atribuir ao usuário.
Remover a atribuição do pacote de acesso para o usuário 4a0b64f2-c7ec-46ba-b117-18f262946c50 nome: accessPackageId
valor: uma ID de pacote de acesso válida para o pacote de acesso que você deseja desatribuir do usuário.
Remover todas as atribuições de pacote de acesso para o usuário 42ae2956-193d-4f39-be06-691b8ac4fa1d Nenhum
Cancelar solicitações pendentes de atribuição de pacote de acesso para o usuário 498770d9-bab7-4e4c-b73d-5ded82a1d0b3 Nenhum

Exemplos

Exemplo 1: Enviar um email de boas-vindas para uma nova contratação

{
    "category": "joiner",
    "continueOnError": false,
    "description": "Send welcome email to new hire",
    "displayName": "Send Welcome Email",
    "isEnabled": true,
    "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
    "arguments": [
        {
            "name": "cc",
            "value": "e94ad2cd-d590-4b39-8e46-bb4f8e293f85,ac17d108-60cd-4eb2-a4b4-084cacda33f2"
        },
        {
            "name": "customSubject",
            "value": "Welcome to the organization {{userDisplayName}}!"
        },
        {
            "name": "customBody",
            "value": "Welcome to our organization {{userGivenName}} {{userSurname}}.\n\nFor more information, reach out to your manager {{managerDisplayName}} at {{managerEmail}}."
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Exemplo 2: Gerar um TAP (Passe de Acesso Temporário) e enviá-lo para o gerenciador do usuário

{
    "category": "joiner",
    "continueOnError": false,
    "description": "Generate Temporary Access Pass and send via email to user's manager",
    "displayName": "Generate TAP and Send Email",
    "isEnabled": true,
    "taskDefinitionId": "1b555e50-7f65-41d5-b514-5894a026d10d",
    "arguments": [
        {
            "name": "tapLifetimeMinutes",
            "value": "480"
        },
        {
            "name": "tapIsUsableOnce",
            "value": "false"
        },
        {
            "name": "cc",
            "value": "068fa0c1-fa00-4f4f-8411-e968d921c3e7,9d208c40-7eb6-46ff-bebd-f30148c39b47"
        },
        {
            "name": "customSubject",
            "value": "Temporary access pass for your new employee {{userDisplayName}}"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nPlease find the temporary access pass for your new employee {{userDisplayName}} below:\n\n{{temporaryAccessPass}}\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Exemplo 3: Adicionar um usuário a grupos

{
    "category": "joiner,leaver",
    "description": "Add user to groups",
    "displayName": "AddUserToGroup",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",
    "arguments": [
        {
            "name": "groupID",
            "value": "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
        }
    ]
}

Exemplo 4: Adicionar um usuário às equipes

{
    "category": "joiner,leaver",
    "description": "Add user to team",
    "displayName": "AddUserToTeam",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "e440ed8d-25a1-4618-84ce-091ed5be5594",
    "arguments": [
        {
            "name": "teamID",
            "value": "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
        }
    ]
}

Exemplo 5: Habilitar uma conta de usuário

{
    "category": "joiner,leaver",
    "description": "Enable user account",
    "displayName": "EnableUserAccount",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
    "arguments": []
}

Exemplo 6: executar uma extensão de tarefa personalizada

{
    "category": "joiner,leaver",
    "description": "Run a Custom Task Extension to call-out to an external system.",
    "displayName": "Run a Custom Task Extension",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "d79d1fcc-16be-490c-a865-f4533b1639ee",
    "arguments": [
        {
            "name": "customTaskExtensionID",
            "value": "<ID of your Custom Task Extension>"
        }
    ]
}

Exemplo 7: Desabilitar uma conta de usuário

{
    "category": "joiner,leaver",
    "description": "Disable user account",
    "displayName": "DisableUserAccount",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
    "arguments": []
}

Exemplo 8: remover um usuário de grupos selecionados

{
    "category": "leaver",
    "displayName": "Remove user from selected groups",
    "description": "Remove user from membership of selected Azure AD groups",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "1953a66c-751c-45e5-8bfe-01462c70da3c",
    "arguments": [
        {
            "name": "groupID",
            "value": "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
        }
    ]
}

Exemplo 9: remover um usuário de todos os grupos

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Remove user from all groups",
    "description": "Remove user from all Azure AD groups memberships",
    "isEnabled": true,
    "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
    "arguments": []
}

Exemplo 10: remover um usuário de equipes selecionadas

{
    "category": "joiner,leaver",
    "continueOnError": true,
    "displayName": "Remove user from selected Teams",
    "description": "Remove user from membership of selected Teams",
    "isEnabled": true,
    "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6",
    "arguments": [
        {
            "name": "teamID",
            "value": "TeamId1, TeamId2, TeamId3, ..."
        }
    ]
}

Exemplo 11: remover um usuário de todas as equipes

{
    "category": "leaver",
    "continueOnError": true,
    "description": "Remove user from all Teams",
    "displayName": "Remove user from all Teams memberships",
    "isEnabled": true,
    "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
    "arguments": []
}

Exemplo 12: remover todas as atribuições de licença de um usuário

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Remove all licenses for user",
    "description": "Remove all licenses assigned to the user",
    "isEnabled": true,
    "taskDefinitionId": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",
    "arguments": []
}

Exemplo 13: excluir um usuário

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Delete user account",
    "description": "Delete user account in Azure AD",
    "isEnabled": true,
    "taskDefinitionId": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",
    "arguments": []
}

Exemplo 14: enviar um email para notificar um gerente de uma movimentação de usuário

{
    "category": "mover",
    "continueOnError": false,
    "description": "Send email to notify user\u2019s manager of user move",
    "displayName": "Send email to notify manager of user move",
    "isEnabled": true,
    "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7",
    "arguments": [
        {
            "name": "cc",
            "value": "ac17d108-60cd-4eb2-a4b4-084cacda33f2,7d3ee937-edcc-46b0-9e2c-f832e01231ea"
        },
        {
            "name": "customSubject",
            "value": "{{userDisplayName}} has moved"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nwe are reaching out to let you know {{userDisplayName}} has moved in the organization.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Exemplo 15: enviar um email para um gerente antes do último dia de um usuário

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Send offboarding email to user's manager before the last day of work",
    "displayName": "Send email before user's last day",
    "isEnabled": true,
    "taskDefinitionId": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935",
    "arguments": [
        {
            "name": "cc",
            "value": "068fa0c1-fa00-4f4f-8411-e968d921c3e7,e94ad2cd-d590-4b39-8e46-bb4f8e293f85"
        },
        {
            "name": "customSubject",
            "value": "Reminder that {{userDisplayName}}'s last day is coming up"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nthis is a reminder that {{userDisplayName}}'s last day is coming up.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Exemplo 16: Enviar um email no último dia de um usuário

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Send offboarding email to user's manager on the last day of work",
    "displayName": "Send email on user's last day",
    "isEnabled": true,
    "taskDefinitionId": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411",
    "arguments": [
        {
            "name": "cc",
            "value": "068fa0c1-fa00-4f4f-8411-e968d921c3e7,e94ad2cd-d590-4b39-8e46-bb4f8e293f85"
        },
        {
            "name": "customSubject",
            "value": "{{userDisplayName}}'s last day"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nthis is a reminder that {{userDisplayName}}'s last day is today and their access will be revoked.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Exemplo 17: enviar o email de offboarding para o gerente de um usuário após o último dia de trabalho do usuário

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Send offboarding email to user's manager after the last day of work",
    "description": "Send email after user's last day",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce",
    "arguments": []
}

Exemplo 18: Solicitar atribuição de pacote de acesso do usuário

{
    "category": "joiner,mover",
    "continueOnError": false,
    "description": "Request user assignment to selected access package",
    "displayName": "Request user access package assignment",
    "isEnabled": true,
    "taskDefinitionId": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be",
    "arguments": [
        {
            "name": "assignmentPolicyId",
            "value": "00d6fd25-6695-4f4a-8186-e4c6f901d2c1"
        },
        {
            "name": "accessPackageId",
            "value": "2ae5d6e5-6cbe-4710-82f2-09ef6ffff0d0"
        }
    ]
}

Exemplo 19: remover a atribuição do pacote de acesso para um usuário

{
    "category": "leaver,mover",
    "continueOnError": false,
    "description": "Remove user assignment of selected access package",
    "displayName": "Remove access package assignment for user",
    "isEnabled": true,
    "taskDefinitionId": "4a0b64f2-c7ec-46ba-b117-18f262946c50",
    "arguments": [
        {
            "name": "accessPackageId",
            "value": "2ae5d6e5-6cbe-4710-82f2-09ef6ffff0d0"
        }
    ]
}

Exemplo 20: remover todas as atribuições de pacote de acesso para um usuário

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Remove all access packages assigned to the user",
    "displayName": "Remove all access package assignments for user",
    "isEnabled": true,
    "taskDefinitionId": "42ae2956-193d-4f39-be06-691b8ac4fa1d",
    "arguments": []
}

Exemplo 21: cancelar solicitações pendentes de atribuição de pacote de acesso para um usuário

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Cancel all access package assignment requests pending for the user",
    "displayName": "Cancel all pending access package assignment requests for user",
    "isEnabled": true,
    "taskDefinitionId": "498770d9-bab7-4e4c-b73d-5ded82a1d0b3",
    "arguments": []
}

Exemplo 22: Enviar email de lembrete de integração

{
    "category": "joiner",
    "continueOnError": false,
    "description": "Send onboarding reminder email to user\u2019s manager",
    "displayName": "Send onboarding reminder email",
    "isEnabled": true,
    "taskDefinitionId": "3C860712-2D37-42A4-928F-5C93935D26A1",
    "arguments": [
        {
            "name": "cc",
            "value": "e94ad2cd-d590-4b39-8e46-bb4f8e293f85,068fa0c1-fa00-4f4f-8411-e968d921c3e7"
        },
        {
            "name": "customSubject",
            "value": "Reminder: {{userDisplayName}} is starting soon"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nthis is a reminder that {{userDisplayName}} is starting soon.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Conteúdo relacionado