Настройка аргументов для встроенных задач рабочего процесса жизненного цикла

  • Статья

API рабочих процессов жизненного цикла в Microsoft Graph позволяет автоматизировать базовые процессы жизненного цикла для пользователей на трех уровнях: Joiner, Leaver и Mover. Основой рабочих процессов являются задачи , представляющие конкретные действия, которые выполняются автоматически при активации рабочего процесса.

Microsoft Graph поддерживает 24 встроенные задачи , которые можно использовать для создания пользовательских рабочих процессов. Каждая задача имеет набор аргументов, допустимых для этой задачи. Например, задача создания временного прохода доступа (TAP) для пользователя позволяет настроить время существования TAP и возможность его повторного использования. Задача добавления пользователя в группу требует указания групп, в которые вы хотите добавить пользователя. Эта конфигурация выполняется в свойстве arguments задачи.

В этой статье приводятся рекомендации по допустимой конфигурации для свойства argumentsзадач в рабочих процессах жизненного цикла.

Настройка аргументов для задач

Отображаемое имя задачи taskDefinitionId Аргументы
Отправить приветственное письмо новому сотруднику 70b29d51-b59a-4773-9280-8841dfd3f2ea name: cc
value: допустимый идентификатор пользователя (строка) для пользователя, который вы хотите получить в сообщении электронной почты.

name: customSubject
value: настраиваемый заголовок темы для отправляемого сообщения электронной почты.


name: customBody
value: текст настраиваемого сообщения электронной почты.


name: locale
value: значение языка, которое переопределяет языковые параметры получателя электронной почты. Этот аргумент не настраивает пользовательский текст сообщения электронной почты и должен быть задан на том же языке, что и пользовательский текст.
Отправить электронное письмо с напоминанием о подключении 3C860712-2D37-42A4-928F-5C93935D26A1 name: cc
value: допустимый идентификатор пользователя (строка) для пользователя, который вы хотите получить в сообщении электронной почты.

name: customSubject
value: настраиваемый заголовок темы для отправляемого сообщения электронной почты.


name: customBody
value: текст настраиваемого сообщения электронной почты.


name: locale
value: значение языка, которое переопределяет языковые параметры получателя электронной почты. Этот аргумент не настраивает пользовательский текст сообщения электронной почты и должен быть задан на том же языке, что и пользовательский текст.
Создание временного пропуска доступа и отправка по электронной почте руководителю пользователя 1b555e50-7f65-41d5-b514-5894a026d10d name: tapLifetimeMinutes
value: 10 upto 43000

name: tapIsUsableOnce
value: true или false

Предварительные требования:
  1. Пользователю должен быть назначен руководитель.
  2. У руководителя пользователя должна быть включена почта.
  3. Политика временного доступа (TAP) должна быть включена в клиенте, и пользователь должен использовать метод проверки подлинности TAP. Дополнительные сведения см. в разделе Тип ресурса temporaryAccessPassAuthenticationMethodConfiguration.
Добавление пользователя в группы 22085229-5809-45e8-97fd-270d28d66910 name: groupID
value: допустимый идентификатор группы или разделенный запятыми список групп, в которые добавляется пользователь в качестве участника. Пример: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Добавление пользователя в teams e440ed8d-25a1-4618-84ce-091ed5be5594 name: teamID
value: допустимый идентификатор группы или разделенный запятыми список команд, в которые добавляется пользователь в качестве участника. Пример: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Включение учетной записи пользователя 6fc52c9d-398b-4305-9763-15f42c1676fc Нет
Запуск пользовательского расширения задач 4262b724-8dba-4fad-afc3-43fcbb497a0e Имя: CustomTaskExtensionID
value: идентификатор расширения настраиваемой задачи.
Назначение лицензий пользователям (предварительная версия) 683c87a4-2ad4-420b-97d4-220d90afcd24 Имя: licenses
value: идентификатор лицензии, которую вы хотите назначить.
Удаление выбранных назначений лицензий от пользователя (предварительная версия) 5fc402a8-daaf-4b7b-9203-da868b05fc5f Имя: licenses
value: идентификатор лицензии, которую вы хотите назначить.
Запуск пользовательского расширения задач 4262b724-8dba-4fad-afc3-43fcbb497a0e name: CustomTaskExtensionID
value: идентификатор расширения настраиваемой задачи.
Отключение учетной записи пользователя 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 Нет
Удаление пользователя из выбранной группы 1953a66c-751c-45e5-8bfe-01462c70da3c name: groupID
value: допустимый идентификатор группы или разделенный запятыми список групп, в которые входит пользователь. Пример: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Удаление пользователей из всех групп b3a31406-2a15-4c9a-b25b-a658fa5f07fc Нет
Удаление пользователя из teams 06aa7acb-01af-4824-8899-b14e5ed788d6 name: teamID
value: разделенный запятыми список команд, в которые входит пользователь. Пример: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Удаление пользователя из всех команд 81f7b200-2816-4b3b-8c5d-dc556f07b024 Нет
Удаление всех назначений лицензий от пользователя 8fa97d28-3e52-4985-b3a9-a1126f9b8b4e Нет
Удаление пользователя 8d18588d-9ad3-4c0f-99d0-ec215f0e3dff Нет
Отправка сообщения электронной почты для уведомления диспетчера о перемещении пользователей aab41899-9972-422a-9d97-f626014578b7 name: cc
value: допустимый идентификатор пользователя (строка) для пользователя, который вы хотите получить в сообщении электронной почты.

name: customSubject
value: настраиваемый заголовок темы для отправляемого сообщения электронной почты.


name: customBody
value: текст настраиваемого сообщения электронной почты.


name: locale
value: значение языка, которое переопределяет языковые параметры получателя электронной почты. Не настраивает настраиваемый текст сообщения электронной почты и должен быть задан на том же языке, что и пользовательский текст.
Отправка электронной почты руководителю до последнего дня пользователя 52853a3e-f4e5-4eb8-bb24-1ac09a1da935 name: cc
value: допустимый идентификатор пользователя (строка) для пользователя, который вы хотите получить в сообщении электронной почты.

name: customSubject
value: настраиваемый заголовок темы для отправляемого сообщения электронной почты.


name: customBody
value: текст настраиваемого сообщения электронной почты.


name: locale
value: значение языка, которое переопределяет языковые параметры получателя электронной почты. Не настраивает настраиваемый текст сообщения электронной почты и должен быть задан на том же языке, что и пользовательский текст.
Отправка электронной почты пользователям в последний день 9c0a1eaf-5bda-4392-9d9e-6e155bb57411 name: cc
value: допустимый идентификатор пользователя (строка) для пользователя, который вы хотите получить в сообщении электронной почты.

name: customSubject
value: настраиваемая тема для отправляемого сообщения электронной почты.


name: customBody
value: текст настраиваемого сообщения электронной почты.


name: locale
value: значение языка, которое переопределяет языковые параметры получателя электронной почты. Не настраивает настраиваемый текст сообщения электронной почты и должен быть задан на том же языке, что и пользовательский текст.
Отправка электронного сообщения о подключении диспетчеру пользователей после последнего дня 6f22ddd4-b3a5-47a4-a846-0d7c201a49ce name: cc
value: допустимый идентификатор пользователя (строка) для пользователя, который вы хотите получить в сообщении электронной почты.

name: customSubject
value: настраиваемый заголовок темы для отправляемого сообщения электронной почты.


name: customBody
value: текст настраиваемого сообщения электронной почты.


name: locale
value: значение языка, которое переопределяет языковые параметры получателя электронной почты. Не настраивает настраиваемый текст сообщения электронной почты и должен быть задан на том же языке, что и пользовательский текст.
Запрос на назначение пакета для доступа пользователя c1ec1e76-f374-4375-aaa6-0bb6bd4c60be name: assignmentPolicyId
value: допустимый идентификатор политики назначения (строка) для пакета доступа, который вы хотите назначить пользователю.

name: accessPackageId
value: допустимый идентификатор пакета доступа для пакета доступа, который вы хотите назначить пользователю.
Удаление назначения пакета доступа для пользователя 4a0b64f2-c7ec-46ba-b117-18f262946c50 name: accessPackageId
value: допустимый идентификатор пакета доступа для пакета доступа, который требуется отменить у пользователя.
Удаление всех назначений пакетов доступа для пользователя 42ae2956-193d-4f39-be06-691b8ac4fa1d Нет
Отмена ожидающих запросов на назначение пакета доступа для пользователя 498770d9-bab7-4e4c-b73d-5ded82a1d0b3 Нет

Примеры

Пример 1. Отправка приветственного сообщения электронной почты новому сотруднику

{
    "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"
        }
    ]
}

Пример 2. Создание временного доступа (TAP) и его отправка диспетчеру пользователя

{
    "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"
        }
    ]
}

Пример 3. Добавление пользователя в группы

{
    "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"
        }
    ]
}

Пример 4. Добавление пользователя в teams

{
    "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"
        }
    ]
}

Пример 5. Включение учетной записи пользователя

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

Пример 6. Запуск пользовательского расширения задач

{
    "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>"
        }
    ]
}

Пример 7. Отключение учетной записи пользователя

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

Пример 8. Удаление пользователя из выбранных групп

{
    "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"
        }
    ]
}

Пример 9. Удаление пользователя из всех групп

{
    "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": []
}

Пример 10. Удаление пользователя из выбранных команд

{
    "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, ..."
        }
    ]
}

Пример 11. Удаление пользователя из всех команд

{
    "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": []
}

Пример 12. Удаление всех назначений лицензий пользователя

{
    "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": []
}

Пример 13. Удаление пользователя

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

Пример 14. Отправка сообщения электронной почты, чтобы уведомить руководителя о перемещении пользователя

{
    "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"
        }
    ]
}

Пример 15. Отправка сообщения электронной почты руководителю до последнего дня пользователя

{
    "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"
        }
    ]
}

Пример 16. Отправка сообщения электронной почты в последний день пользователя

{
    "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"
        }
    ]
}

Пример 17. Отправка сообщения электронной почты об отключении руководителю пользователя после последнего рабочего дня пользователя

{
    "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": []
}

Пример 18. Запрос на назначение пакета доступа пользователя

{
    "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"
        }
    ]
}

Пример 19. Удаление назначения пакета доступа для пользователя

{
    "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"
        }
    ]
}

Пример 20. Удаление всех назначений пакетов доступа для пользователя

{
    "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": []
}

Пример 21. Отмена ожидающих запросов на назначение пакета доступа для пользователя

{
    "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": []
}

Пример 22. Отправка электронной почты с напоминанием о подключении

{
    "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"
        }
    ]
}

Связанные материалы