組み込みのライフサイクル ワークフロー タスクの引数を構成する

  • [アーティクル]

Microsoft Graph のライフサイクル ワークフロー API を使用すると、Joiner、Leaver、Mover の 3 つのレベルでユーザーの基本的なライフサイクル プロセスを自動化できます。 ワークフローの中核となるのは、ワークフローがトリガーされたときに自動的に実行される特定のアクションを表す タスク です。

Microsoft Graph では、カスタム ワークフローの作成に使用できる 24 個の組み込みタスク がサポートされています。 各タスクには、そのタスクに対して許可される引数のセットがあります。 たとえば、ユーザーの一時アクセス パス (TAP) を生成するタスクでは、TAP の有効期間と、ユーザーが再利用できるかどうかを構成できます。 ユーザーをグループに追加するタスクでは、ユーザーを追加するグループを指定する必要があります。 この構成は、タスクの arguments プロパティで行われます。

この記事では、ライフサイクル ワークフローのタスクの arguments プロパティに対して許可される構成に関するガイダンスを提供します。

タスクの引数を構成する

タスクの表示名 taskDefinitionId 引数
新入社員にウェルカム メールを送信する 70b29d51-b59a-4773-9280-8841dfd3f2ea name: cc
value: 電子メールで cc するユーザーの有効なユーザー ID (文字列)。

name: customSubject
value: 送信される電子メールのカスタム件名ヘッダー。


name: customBody
value: カスタマイズされたメールの本文。


name: locale
value: メール受信者の言語設定をオーバーライドする言語値。 この引数は電子メールのカスタム テキストをカスタマイズしないため、カスタム テキストと同じ言語で設定する必要があります。
オンボードリマインダーメールを送信する 3C860712-2D37-42A4-928F-5C93935D26A1 name: cc
value: 電子メールで cc するユーザーの有効なユーザー ID (文字列)。

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: 有効なグループ ID、またはユーザーがメンバーとして追加されるグループのコンマ区切りのリスト。 たとえば、"06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f" のように指定します。
チームにユーザーを追加する e440ed8d-25a1-4618-84ce-091ed5be5594 name: teamID
value: 有効なグループ ID、またはユーザーがメンバーとして追加されるチームのコンマ区切りのリスト。 たとえば、"06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f" のように指定します。
ユーザー アカウントの有効化 6fc52c9d-398b-4305-9763-15f42c1676fc name: enableOnPremisesAccount
value: タスクで同期されたオンプレミス ユーザー アカウントを有効にするかどうかを示すブール値。
カスタム タスク拡張機能を実行する 4262b724-8dba-4fad-afc3-43fcbb497a0e 名前： CustomTaskExtensionID
value: カスタム タスク拡張機能の ID
ユーザーにライセンスを割り当てる (プレビュー) 683c87a4-2ad4-420b-97d4-220d90afcd24 名前： licenses
value: 割り当てるライセンスの ID
選択したライセンスの割り当てをユーザーから削除する (プレビュー) 5fc402a8-daaf-4b7b-9203-da868b05fc5f 名前： licenses
value: 割り当てるライセンスの ID
カスタム タスク拡張機能を実行する 4262b724-8dba-4fad-afc3-43fcbb497a0e name: CustomTaskExtensionID
value: カスタム タスク拡張機能の ID
ユーザー アカウントを無効にする 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 name: disableOnPremisesAccount
value: タスクが同期されたオンプレミス ユーザー アカウントを無効にするかどうかを示すブール値。
選択したグループからユーザーを削除する 1953a66c-751c-45e5-8bfe-01462c70da3c name: groupID
value: 有効なグループ ID、またはユーザーがメンバーになっているグループのコンマ区切りのリスト。 たとえば、"06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f" のように指定します。
すべてのグループからユーザーを削除する b3a31406-2a15-4c9a-b25b-a658fa5f07fc なし
チームからユーザーを削除する 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 name: deleteOnPremisesAccount
value: タスクが同期されたオンプレミス ユーザー アカウントを削除するかどうかを示すブール値。
ユーザーの移動をマネージャーに通知する電子メールを送信する aab41899-9972-422a-9d97-f626014578b7 name: cc
value: 電子メールで cc するユーザーの有効なユーザー ID (文字列)。

name: customSubject
value: 送信される電子メールのカスタム件名ヘッダー。


name: customBody
value: カスタマイズされたメールの本文。


name: locale
value: メール受信者の言語設定をオーバーライドする言語値。 メールのカスタム テキストはカスタマイズせず、カスタム テキストと同じ言語で設定する必要があります。
ユーザーの最後の日の前にマネージャーにメールを送信する 52853a3e-f4e5-4eb8-bb24-1ac09a1da935 name: cc
value: 電子メールで cc するユーザーの有効なユーザー ID (文字列)。

name: customSubject
value: 送信される電子メールのカスタム件名ヘッダー。


name: customBody
value: カスタマイズされたメールの本文。


name: locale
value: メール受信者の言語設定をオーバーライドする言語値。 メールのカスタム テキストはカスタマイズせず、カスタム テキストと同じ言語で設定する必要があります。
ユーザーの最後の日に電子メールを送信する 9c0a1eaf-5bda-4392-9d9e-6e155bb57411 name: cc
value: 電子メールで cc するユーザーの有効なユーザー ID (文字列)。

name: customSubject
value: 送信されるメールのカスタム件名。


name: customBody
value: カスタマイズされたメールの本文。


name: locale
value: メール受信者の言語設定をオーバーライドする言語値。 メールのカスタム テキストはカスタマイズせず、カスタム テキストと同じ言語で設定する必要があります。
最終日の後にオフボードメールをユーザー マネージャーに送信する 6f22dddd4-b3a5-47a4-a846-0d7c201a49ce name: cc
value: 電子メールで cc するユーザーの有効なユーザー ID (文字列)。

name: customSubject
value: 送信される電子メールのカスタム件名ヘッダー。


name: customBody
value: カスタマイズされたメールの本文。


name: locale
value: メール受信者の言語設定をオーバーライドする言語値。 メールのカスタム テキストはカスタマイズせず、カスタム テキストと同じ言語で設定する必要があります。
ユーザー アクセス パッケージの割り当てを要求する c1ec1e76-f374-4375-aaa6-0bb6bd4c60be name: assignmentPolicyId
value: ユーザーを割り当てるアクセス パッケージの有効な割り当てポリシー ID (文字列)。

name: accessPackageId
value: ユーザーに割り当てるアクセス パッケージの有効なアクセス パッケージ ID。
ユーザーのアクセス パッケージの割り当てを削除する 4a0b64f2-c7ec-46ba-b117-18f262946c50 name: accessPackageId
value: ユーザーからの割り当てを解除するアクセス パッケージの有効なアクセス パッケージ ID。
ユーザーのすべてのアクセス パッケージの割り当てを削除する 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: チームにユーザーを追加する

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

関連コンテンツ