Compartilhar via

Configurar os argumentos para tarefas incorporadas de Fluxos de Trabalho do Ciclo de Vida

As APIs de Fluxos de Trabalho do Ciclo de Vida do Microsoft Graph permitem-lhe automatizar os processos de ciclo de vida dos utilizadores aos níveis de associação, leaver e mover.

O núcleo dos fluxos de trabalho são tarefas que representam ações específicas que são executadas automaticamente quando um fluxo de trabalho é acionado. Estão disponíveis 24 tarefas incorporadas para suportar a criação de fluxos de trabalho personalizados. Estas tarefas são configuradas nas propriedades dos argumentos de uma definição de tarefa.

Este artigo explica como configurar a propriedade argumentos para tarefas incorporadas para simplificar a automatização.

Configurar argumentos para tarefas

Nome a apresentar da tarefa taskDefinitionId argumentos
Enviar e-mail de boas-vindas para nova contratação 70b29d51-b59a-4773-9280-8841dfd3f2ea name: cc
valor: um ID de utilizador (Cadeia) válido para o utilizador que pretende cc no e-mail.

name: customSubject
valor: um cabeçalho de assunto personalizado para o e-mail que está a ser enviado.

name: customBody
valor: o corpo do e-mail personalizado.

name: locale
valor: valor de idioma que substitui as definições de idioma do destinatário do e-mail. Este argumento não personaliza o texto personalizado do e-mail e deve ser definido no mesmo idioma que o texto personalizado.

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .
Enviar e-mail de lembrete de inclusão 3C860712-2D37-42A4-928F-5C93935D26A1 name: cc
valor: um ID de utilizador (Cadeia) válido para o utilizador que pretende cc no e-mail.

name: customSubject
valor: um cabeçalho de assunto personalizado para o e-mail que está a ser enviado.

name: customBody
valor: o corpo do e-mail personalizado.

name: locale
valor: valor de idioma que substitui as definições de idioma do destinatário do e-mail. Este argumento não personaliza o texto personalizado do e-mail e deve ser definido no mesmo idioma que o texto personalizado.

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .
Gerar o Passe de Acesso Temporário e enviar por e-mail para o gestor do utilizador 1b555e50-7f65-41d5-b514-5894a026d10d name: tapLifetimeMinutes
valor: 10 até 43000

name: tapIsUsableOnce
valor: true ou false

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .

Pré-requisitos:
  1. Tem de ser atribuído um gestor ao utilizador.
  2. O gestor do utilizador tem de ter o correio ativado.
  3. A política de acesso temporário (TAP) tem de estar ativada no inquilino e o utilizador está ativado para utilizar o método de autenticação TAP. Para obter mais informações, veja temporaryAccessPassAuthenticationMethodConfiguration resource type (Tipo de recurso temporaryAccessPassAuthenticationMethodConfiguration).
Adicionar utilizador a grupos 22085229-5809-45e8-97fd-270d28d66910 name: groupID
valor: um ID de grupo válido ou uma lista separada por vírgulas de grupos aos quais o utilizador é adicionado como membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f".
Adicionar utilizadores às equipas e440ed8d-25a1-4618-84ce-091ed5be5594 name: teamID
valor: um ID de grupo válido ou uma lista separada por vírgulas de equipas às quais o utilizador é 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 name: enableOnPremisesAccount
valor: um valor booleano que indica se a tarefa ativa contas de utilizador sincronizadas no local.
Executar uma extensão de tarefa personalizada 4262b724-8dba-4fad-afc3-43fcbb497a0e name: CustomTaskExtensionID
value: o ID da extensão de tarefa personalizada.
Atribuir licenças a utilizadores (Pré-visualização) 683c87a4-2ad4-420b-97d4-220d90afcd24 name: licenses
valor: o ID da licença que pretende atribuir.
Remover atribuições de licenças selecionadas do utilizador (Pré-visualização) 5fc402a8-daaf-4b7b-9203-da868b05fc5f name: licenses
valor: o ID da licença que pretende atribuir.
Revogar todos os tokens de atualização do utilizador 509589a4-0466-4471-829e-49c5e502bdee Nenhuma.
Desativar conta de utilizador 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 name: disableOnPremisesAccount
valor: um valor booleano que indica se a tarefa desativa contas de utilizador sincronizadas no local.
Remover utilizador do grupo selecionado 1953a66c-751c-45e5-8bfe-01462c70da3c name: groupID
valor: um ID de grupo válido ou uma lista separada por vírgulas de grupos dos quais o utilizador é membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f".
Remover utilizadores de todos os grupos b3a31406-2a15-4c9a-b25b-a658fa5f07fc Nenhum
Remover utilizadores das equipas 06aa7acb-01af-4824-8899-b14e5ed788d6 name: teamID
valor: uma lista separada por vírgulas de equipas das quais o utilizador é membro. Por exemplo, "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f".
Remover utilizadores de todas as equipas 81f7b200-2816-4b3b-8c5d-dc556f07b024 Nenhum
Remover todas as atribuições de licença do utilizador 8fa97d28-3e52-4985-b3a9-a1126f9b8b4e Nenhum
Excluir usuário 8d18588d-9ad3-4c0f-99d0-ec215f0e3dff name: deleteOnPremisesAccount
valor: um valor booleano que indica se a tarefa elimina contas de utilizador sincronizadas no local.
Enviar e-mail para notificar o gestor de movimentação de utilizadores aab41899-9972-422a-9d97-f626014578b7 name: cc
valor: um ID de utilizador (Cadeia) válido para o utilizador que pretende cc no e-mail.

name: customSubject
valor: um cabeçalho de assunto personalizado para o e-mail que está a ser enviado.

name: customBody
valor: o corpo do e-mail personalizado.

name: locale
valor: valor de idioma que substitui as definições de idioma do destinatário do e-mail. Não personaliza o texto personalizado do e-mail e deve ser definido no mesmo idioma que o texto personalizado.

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .
Enviar e-mail ao gestor antes do último dia do utilizador 52853a3e-f4e5-4eb8-bb24-1ac09a1da935 name: cc
valor: um ID de utilizador (Cadeia) válido para o utilizador que pretende cc no e-mail.

name: customSubject
valor: um cabeçalho de assunto personalizado para o e-mail que está a ser enviado.

name: customBody
valor: o corpo do e-mail personalizado.

name: locale
valor: valor de idioma que substitui as definições de idioma do destinatário do e-mail. Não personaliza o texto personalizado do e-mail e deve ser definido no mesmo idioma que o texto personalizado.

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .
Enviar e-mail no último dia do utilizador 9c0a1eaf-5bda-4392-9d9e-6e155bb57411 name: cc
valor: um ID de utilizador (Cadeia) válido para o utilizador que pretende cc no e-mail.

name: customSubject
valor: um assunto personalizado para o e-mail que está a ser enviado.

name: customBody
valor: o corpo do e-mail personalizado.

name: locale
valor: valor de idioma que substitui as definições de idioma do destinatário do e-mail. Não personaliza o texto personalizado do e-mail e deve ser definido no mesmo idioma que o texto personalizado.

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .
Enviar e-mail de exclusão para o gestor do utilizador após o último dia 6f22ddd4-b3a5-47a4-a846-0d7c201a49ce name: cc
valor: um ID de utilizador (Cadeia) válido para o utilizador que pretende cc no e-mail.

name: customSubject
valor: um cabeçalho de assunto personalizado para o e-mail que está a ser enviado.

name: customBody
valor: o corpo do e-mail personalizado.

name: locale
valor: valor de idioma que substitui as definições de idioma do destinatário do e-mail. Não personaliza o texto personalizado do e-mail e deve ser definido no mesmo idioma que o texto personalizado.

name: to
value: User, Managers, Sponsorsou a cadeia de carateres de um específico userID. Se Sponsors estiver selecionado, não poderá adicionar outro utilizador no cc argumento .
Pedir atribuição de pacote de acesso de utilizador c1ec1e76-f374-4375-aaa6-0bb6bd4c60be name: assignmentPolicyId
valor: um ID de política de atribuição (Cadeia) válido para o pacote de acesso que pretende atribuir ao utilizador.

name: accessPackageId
valor: um ID de pacote de acesso válido para o pacote de acesso que pretende atribuir ao utilizador.
Remover a atribuição de pacotes de acesso para o utilizador 4a0b64f2-c7ec-46ba-b117-18f262946c50 name: accessPackageId
valor: um ID de pacote de acesso válido para o pacote de acesso que pretende anular a atribuição do utilizador.
Remover todas as atribuições de pacotes de acesso para o utilizador 42ae2956-193d-4f39-be06-691b8ac4fa1d Nenhum
Cancelar pedidos de atribuição de pacotes de acesso pendentes para o utilizador 498770d9-bab7-4e4c-b73d-5ded82a1d0b3 name: daysUntilExpiration
valor: uma cadeia válida dos dias até que a atribuição do pacote de acesso para o utilizador expire.

Exemplos

Exemplo 1: enviar um e-mail 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 Passe de Acesso Temporário (TAP) e enviá-lo para o gestor do utilizador

{
  "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 utilizador 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 utilizador às equipas

{
  "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: Ativar uma conta de utilizador

{
  "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: Desativar uma conta de utilizador

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

Exemplo 8: Remover um utilizador dos 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 utilizador 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 utilizador das equipas 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 utilizador de todas as equipas

{
  "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 utilizador

{
  "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: Eliminar um utilizador

{
  "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 e-mail para notificar um gestor de uma movimentação de utilizador

{
  "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 e-mail para um gestor antes do último dia de um utilizador

{
  "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 e-mail no último dia de um utilizador

{
  "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 e-mail de exclusão para o gestor de um utilizador após o último dia de trabalho do utilizador

{
  "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: Pedir atribuição de pacote de acesso de utilizador

{
  "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 de pacotes de acesso para um utilizador

{
  "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 pacotes de acesso de um utilizador

{
  "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": [
        {
             "description": "Remove all access packages assigned to the user",
            "displayName": "Remove all access package assignments for user",
            "id": "42ae2956-193d-4f39-be06-691b8ac4fa1d",
            "version": 1,
            "parameters": [
                {
                    "name": "daysUntilExpiration",
                    "values": [],
                    "valueType": "string"
                }
            ]
        }
    ]
}

Exemplo 21: Cancelar pedidos de atribuição de pacotes de acesso pendentes para um utilizador

{
  "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 e-mail de lembrete de inclusã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"
    }
  ]
}

Exemplo 23: Revogar todos os tokens de atualização do utilizador

{
  "category": "leaver, mover",
  "continueOnError": false,
  "description": "Revoke all refresh tokens for user",
  "displayName": "Revoke all refresh tokens for user",
  "isEnabled": true,
  "taskDefinitionId": "509589a4-0466-4471-829e-49c5e502bdee",
  "arguments": []
}

Conteúdo relacionado

  • Last updated on