taskDefinitions を一覧表示する
名前空間: microsoft.graph.identityGovernance
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
ライフサイクル ワークフローの組み込みワークフロー タスクの一覧を取得します。 タスクは taskDefinition オブジェクトによって表されます。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | LifecycleWorkflows.Read.All | LifecycleWorkflows.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | LifecycleWorkflows.Read.All | LifecycleWorkflows.ReadWrite.All |
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 グローバル 閲覧者 および ライフサイクル ワークフロー管理者 は、この操作でサポートされる最小限の特権ロールです。
HTTP 要求
GET /identityGovernance/lifecycleWorkflows/taskDefinitions
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ OData クエリ パラメーターの $select
、 $orderby
、 $filter
をサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文の microsoft.graph.identityGovernance.taskDefinition オブジェクトのコレクションを返します。
例
例 1: 組み込みタスク定義をすべて取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",
"@odata.count": 24,
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identityGovernance/lifecycleWorkflows/taskDefinitions?$select=category,continueOnError",
"value": [
{
"category": "joiner,leaver,mover",
"description": "Add user to selected groups",
"displayName": "Add user to groups",
"id": "22085229-5809-45e8-97fd-270d28d66910",
"version": 1,
"parameters": [
{
"name": "groupID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,leaver",
"description": "Disable user account in the directory",
"displayName": "Disable user account",
"id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
"version": 1,
"parameters": [
{
"name": "disableOnPremisesAccount",
"values": [
"true",
"false"
],
"valueType": "enum"
}
]
},
{
"category": "joiner,leaver",
"description": "Enable user account in the directory",
"displayName": "Enable user account",
"id": "6fc52c9d-398b-4305-9763-15f42c1676fc",
"version": 1,
"parameters": [
{
"name": "enableOnPremisesAccount",
"values": [
"true",
"false"
],
"valueType": "enum"
}
]
},
{
"category": "joiner,leaver,mover",
"description": "Remove user from membership of selected Azure AD groups",
"displayName": "Remove user from selected groups",
"id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
"version": 1,
"parameters": [
{
"name": "groupID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner",
"description": "Generate Temporary Access Pass and send via email to user's manager",
"displayName": "Generate TAP and send email",
"id": "1b555e50-7f65-41d5-b514-5894a026d10d",
"version": 1,
"parameters": [
{
"name": "tapLifetimeMinutes",
"values": [],
"valueType": "string"
},
{
"name": "tapIsUsableOnce",
"values": [
"true",
"false"
],
"valueType": "enum"
},
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner",
"description": "Send welcome email to new hire",
"displayName": "Send welcome email",
"id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
"version": 1,
"parameters": [
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,leaver,mover",
"description": "Add user to selected Teams",
"displayName": "Add user to Teams",
"id": "e440ed8d-25a1-4618-84ce-091ed5be5594",
"version": 1,
"parameters": [
{
"name": "teamID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver",
"description": "Delete user account in Azure AD",
"displayName": "Delete user account",
"id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",
"version": 1,
"parameters": [
{
"name": "deleteOnPremisesAccount",
"values": [
"true",
"false"
],
"valueType": "enum"
}
]
},
{
"category": "joiner,leaver,mover",
"description": "Remove user from membership of selected Teams",
"displayName": "Remove user from selected Teams",
"id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
"version": 1,
"parameters": [
{
"name": "teamID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver",
"description": "Remove user from all Azure AD groups memberships",
"displayName": "Remove user from all groups",
"id": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
"version": 1,
"parameters": []
},
{
"category": "leaver",
"description": "Remove user from all Teams memberships",
"displayName": "Remove user from all Teams",
"id": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
"version": 1,
"parameters": []
},
{
"category": "leaver",
"description": "Remove all licenses assigned to the user",
"displayName": "Remove all licenses for user",
"id": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",
"version": 1,
"parameters": []
},
{
"category": "joiner,leaver,mover",
"description": "Run a Custom Task Extension to callout to an external system.",
"displayName": "Run a Custom Task Extension",
"id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
"version": 1,
"parameters": [
{
"name": "customTaskExtensionID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver",
"description": "Send offboarding email to user's manager before the last day of work",
"displayName": "Send email before user's last day",
"id": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935",
"version": 1,
"parameters": [
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver",
"description": "Send offboarding email to user's manager on the last day of work",
"displayName": "Send email on user's last day",
"id": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411",
"version": 1,
"parameters": [
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver",
"description": "Send offboarding email to user's manager after the last day of work",
"displayName": "Send email after user's last day",
"id": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce",
"version": 1,
"parameters": [
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner",
"description": "Send onboarding reminder email to user's manager",
"displayName": "Send onboarding reminder email",
"id": "3C860712-2D37-42A4-928F-5C93935D26A1",
"version": 1,
"parameters": [
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,mover",
"description": "Request user assignment to selected access package",
"displayName": "Request user access package assignment",
"id": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be",
"version": 1,
"parameters": [
{
"name": "assignmentPolicyId",
"values": [],
"valueType": "string"
},
{
"name": "accessPackageId",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver,mover",
"description": "Remove user assignment of selected access package",
"displayName": "Remove access package assignment for user",
"id": "4a0b64f2-c7ec-46ba-b117-18f262946c50",
"version": 1,
"parameters": [
{
"name": "accessPackageId",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver",
"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": []
},
{
"category": "leaver",
"description": "Cancel all pending access packages assignment requests for the user",
"displayName": "Cancel pending access package assignment requests for user",
"id": "498770d9-bab7-4e4c-b73d-5ded82a1d0b3",
"version": 1,
"parameters": []
},
{
"category": "mover",
"description": "Send email to notify user's manager of user move",
"displayName": "Send email to notify manager of user move",
"id": "aab41899-9972-422a-9d97-f626014578b7",
"version": 1,
"parameters": [
{
"name": "cc",
"values": [],
"valueType": "string"
},
{
"name": "customSubject",
"values": [],
"valueType": "string"
},
{
"name": "customBody",
"values": [],
"valueType": "string"
},
{
"name": "locale",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,mover",
"description": "Assign selected licenses to the user",
"displayName": "Assign licenses to user",
"id": "683c87a4-2ad4-420b-97d4-220d90afcd24",
"version": 1,
"parameters": [
{
"name": "licenses",
"values": [],
"valueType": "string"
}
]
},
{
"category": "leaver,mover",
"description": "Remove selected licenses assigned to the user",
"displayName": "Remove licenses from user",
"id": "5fc402a8-daaf-4b7b-9203-da868b05fc5f",
"version": 1,
"parameters": [
{
"name": "licenses",
"values": [],
"valueType": "string"
}
]
}
]
}
例 2: "joiner" ワークフローでサポートされているすべての組み込みタスクを取得する
要求
次の例は要求を示しています。
カテゴリは、joiner
、joiner,leaver
、またはleaver
のいずれかであるフラグ付き列挙であるため、has
演算子は、カテゴリに "joiner" が含まれているタスクをチェックします。
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions?$filter=category has 'joiner'
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",
"value": [
{
"category": "joiner,leaver",
"description": "Add user to selected groups",
"displayName": "Add User To Groups",
"id": "22085229-5809-45e8-97fd-270d28d66910",
"version": 1,
"parameters": [
{
"name": "groupID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,leaver",
"description": "Disable user account in the directory",
"displayName": "Disable User Account",
"id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
"version": 1,
"parameters": []
},
{
"category": "joiner,leaver",
"description": "Enable user account in the directory",
"displayName": "Enable User Account",
"id": "6fc52c9d-398b-4305-9763-15f42c1676fc",
"version": 1,
"parameters": []
},
{
"category": "joiner,leaver",
"description": "Remove user from membership of selected Azure AD groups",
"displayName": "Remove user from selected groups",
"id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
"version": 1,
"parameters": [
{
"name": "groupID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner",
"description": "Generate Temporary Access Pass and send via email to user's manager",
"displayName": "Generate TAP And Send Email",
"id": "1b555e50-7f65-41d5-b514-5894a026d10d",
"version": 1,
"parameters": [
{
"name": "tapLifetimeMinutes",
"values": [],
"valueType": "string"
},
{
"name": "tapIsUsableOnce",
"values": [
"true",
"false"
],
"valueType": "enum"
}
]
},
{
"category": "joiner",
"description": "Send welcome email to new hire",
"displayName": "Send Welcome Email",
"id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
"version": 1,
"parameters": []
},
{
"category": "joiner,leaver",
"description": "Add user to selected teams",
"displayName": "Add User To Teams",
"id": "e440ed8d-25a1-4618-84ce-091ed5be5594",
"version": 1,
"parameters": [
{
"name": "teamID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,leaver",
"description": "Remove user from membership of selected Teams",
"displayName": "Remove user from selected Teams",
"id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
"version": 1,
"parameters": [
{
"name": "teamID",
"values": [],
"valueType": "string"
}
]
},
{
"category": "joiner,leaver",
"description": "Run a Custom Task Extension to callout to an external system.",
"displayName": "Run a Custom Task Extension",
"id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
"version": 1,
"parameters": [
{
"name": "customTaskExtensionID",
"values": [],
"valueType": "string"
}
]
}
]
}