ワークフローをリスト
名前空間: microsoft.graph.identityGovernance
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
ライフサイクル ワークフローに関連付けられているワークフロー リソースの一覧を取得します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | LifecycleWorkflows.ReadBasic.Workflows | LifecycleWorkflows.Read.All、LifecycleWorkflows.Read.Workflows、LifecycleWorkflows.ReadWrite.All、LifecycleWorkflows.ReadWrite.Workflows |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | LifecycleWorkflows.ReadBasic.Workflows | LifecycleWorkflows.Read.All、LifecycleWorkflows.Read.Workflows、LifecycleWorkflows.ReadWrite.All、LifecycleWorkflows.ReadWrite.Workflows |
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 グローバル 閲覧者 および ライフサイクル ワークフロー管理者 は、この操作でサポートされる最小限の特権ロールです。
HTTP 要求
GET /identityGovernance/lifecycleWorkflows/workflows
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ OData クエリ パラメーターの $search
、 $orderby
、 $filter
をサポートします。
$expand
は createdBy リレーションシップと lastModifiedBy リレーションシップでのみサポートされます。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文の microsoft.graph.identityGovernance.workflow オブジェクトのコレクションを返します。
例
例 1: テナントで作成されたすべてのワークフローを取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows",
"value": [
{
"category": "joiner",
"description": "Configure pre-hire tasks for onboarding employees before their first day",
"displayName": "Global pre hire",
"lastModifiedDateTime": "2022-08-16T20:05:51.4618603Z",
"createdDateTime": "2022-01-10T20:04:30.619368Z",
"id": "c007a148-5bf1-4f38-82b4-377fb23b1711",
"isEnabled": true,
"isSchedulingEnabled": true,
"version": 12
},
{
"category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day",
"displayName": "Global new hire",
"lastModifiedDateTime": "2022-08-18T17:24:42.6051254Z",
"createdDateTime": "2022-05-06T14:10:39.9700268Z",
"id": "559d8339-ab4e-4c41-a517-ed5d8dd9fbf5",
"isEnabled": true,
"isSchedulingEnabled": true,
"version": 5
},
{
"category": "joiner",
"description": "Configure pre-hire tasks for onboarding employees before their first day",
"displayName": "Onboard pre-hire employee",
"lastModifiedDateTime": "2022-08-16T20:01:28.3589067Z",
"createdDateTime": "2022-08-16T17:48:55.2262907Z",
"id": "d0454160-b8e9-432f-8a85-790021e64c9e",
"isEnabled": false,
"isSchedulingEnabled": false,
"version": 1
},
{
"category": "leaver",
"description": "Configure offboarding tasks for employees after their last day of work",
"displayName": "Post-Offboarding of an employee",
"lastModifiedDateTime": "2022-08-17T18:57:30.5091553Z",
"createdDateTime": "2022-08-17T18:57:07.1840042Z",
"id": "15f9c6db-ada8-4417-927f-17ac24b54b9b",
"isEnabled": true,
"isSchedulingEnabled": false,
"version": 1
},
{
"category": "leaver",
"description": "Execute real-time termination tasks for employees on their last day of work",
"displayName": "Real-time employee termination",
"lastModifiedDateTime": "2022-08-19T20:34:15.4212506Z",
"createdDateTime": "2022-08-19T20:34:15.4212481Z",
"id": "57bc6612-2c20-4141-9dab-aa11a95b8fbc",
"isEnabled": true,
"isSchedulingEnabled": false,
"version": 1
},
{
"category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day",
"displayName": "Onboard new hire employee",
"lastModifiedDateTime": "2022-08-24T15:39:17.6496744Z",
"createdDateTime": "2022-08-24T15:39:17.6496704Z",
"id": "156ce798-1eb6-4e0a-8515-e79f54d04390",
"isEnabled": true,
"isSchedulingEnabled": false,
"version": 1
}
]
}
例 2: "leaver" ワークフローの特定のプロパティのみを取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows?$filter=category eq 'leaver'&$select=id,category,displayName,isEnabled,isSchedulingEnabled
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows(category,displayName,isEnabled,isSchedulingEnabled)",
"value": [
{
"category": "leaver",
"displayName": "Pre-Offboarding employees in the R&D department",
"id": "c0548e6c-8849-46e8-be14-8b6d2b04957e",
"isEnabled": true,
"isSchedulingEnabled": true
}
]
}