ワークフロー: activateAndWait

名前空間: microsoft.graph.identityGovernance

指定したサブジェクトの ライフサイクル ワークフロー をアクティブ化し、実行が完了するまで同期的に待機します。 このアクションは、実行結果を含む awaitedWorkflowProcessingResult を返します。 このアクションは、非ユーザーサブジェクトをプロビジョニングする場合など、ワークフローの完了を即時に確認する必要がある場合に使用します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) LifecycleWorkflows-Workflow.Activate LifecycleWorkflows-Workflow.ReadWrite.All、LifecycleWorkflows.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション LifecycleWorkflows-Workflow.Activate LifecycleWorkflows-Workflow.ReadWrite.All、LifecycleWorkflows.ReadWrite.All

HTTP 要求

POST /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/activateAndWait

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

次の表に、このアクションを呼び出すときに必要なパラメーターを示します。

パラメーター 型 説明
subject microsoft.graph.identityGovernance.workflowSubject ワークフローをアクティブ化するサブジェクト。 派生型 (#microsoft.graph.identityGovernance.provisioningObjectWorkflowSubject など) を指定するには @odata.type プロパティを含める必要があります。 必須です。

応答

成功した場合、このアクションは 200 OK 応答コードと応答本文の awaitedWorkflowProcessingResult を返します。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/14879a93-6b91-4153-b7e6-5df4a7b7c5c8/activateAndWait
Content-Type: application/json

{
  "subject": {
    "@odata.type": "#microsoft.graph.identityGovernance.provisioningObjectWorkflowSubject",
    "id": "b74f0fae-b1f3-4c96-9bf0-d4d8a8e37cbe",
    "attributeSetEntries": [
      {
        "name": "department",
        "value": "Engineering"
      },
      {
        "name": "jobTitle",
        "value": "Software Engineer"
      }
    ]
  }
}

応答

次の例は応答を示しています。

注:

ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.identityGovernance.awaitedWorkflowProcessingResult",
  "processingStatus": "completed",
  "statusReasons": [],
  "subject": {
    "@odata.type": "#microsoft.graph.identityGovernance.provisioningObjectWorkflowSubject",
    "id": "b74f0fae-b1f3-4c96-9bf0-d4d8a8e37cbe",
    "attributeSetEntries": [
      {
        "name": "department",
        "value": "Engineering"
      },
      {
        "name": "jobTitle",
        "value": "Software Engineer"
      }
    ]
  }
}
  • Last updated on