割り当ての作成ScheduleRequest

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい privilegedAccessGroupAssignmentScheduleRequest オブジェクトを 作成します。

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

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

アクセス許可

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

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

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーがグループの所有者またはメンバーであるか、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールが割り当てられている必要があります。 この操作では、次の最小特権ロールがサポートされています。

  • ロール割り当て可能なグループの場合: 特権ロール管理者
  • ロール割り当て不可グループの場合: ディレクトリ ライター、 グループ管理者、 ID ガバナンス管理者、または ユーザー管理者

呼び出し元ユーザーのロールの割り当ては、ディレクトリ レベルでスコープを設定する必要があります。

グループを管理するためのアクセス許可を持つ他のロール (ロール割り当て不可の Microsoft 365 グループの Exchange 管理者など) と、管理単位レベルでスコープが設定された割り当てを持つ管理者は、グループ API を使用してグループを管理し、グループ API の PIM を介して Microsoft Entra PIM で行われた変更をオーバーライドできます。

HTTP 要求

POST /identityGovernance/privilegedAccess/group/assignmentScheduleRequests

要求ヘッダー

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

要求本文

要求本文で、 privilegedAccessGroupAssignmentScheduleRequest オブジェクトの JSON 表現を指定します。

privilegedAccessGroupAssignmentScheduleRequest を作成するときに、次のプロパティを指定できます。

プロパティ 型 説明
accessId privilegedAccessGroupRelationships グループへのメンバーシップまたは所有権の割り当て関係の識別子。 使用可能な値は、 owner、 memberです。 必須です。
action String グループ メンバーシップまたは所有権の割り当て要求に対する操作の種類を表します。 使用可能な値: adminAssign、adminUpdate、adminRemove、selfActivate、selfDeactivate、adminExtend、adminRenew。
  • adminAssign: 管理者がグループ メンバーシップまたは所有権をプリンシパルに割り当てる場合。
  • adminRemove: 管理者がグループ メンバーシップまたは所有権からプリンシパルを削除する場合。
  • adminUpdate: 管理者が既存のグループ メンバーシップまたは所有権の割り当てを変更する場合。
  • adminExtend: 管理者が期限切れの割り当てを延長する場合。
  • adminRenew: 管理者が期限切れの割り当てを更新する場合。
  • selfActivate: プリンシパルが割り当てをアクティブ化する場合。
  • selfDeactivate: プリンシパルがアクティブな割り当てを非アクティブ化する。
必須です。
customData String 要求のカスタム データを定義するフリー テキスト フィールド。 省略可能。
groupId String グループの PIM を介したメンバーシップまたは所有権の割り当てのスコープを表すグループの識別子。 必須です。
ジャスティフィケーション String ユーザーと管理者が privilegedAccessGroupAssignmentScheduleRequest オブジェクトを作成するときに提供されるメッセージ。 省略可能。
principalId String グループの PIM を通じてメンバーシップまたは所有権の割り当てが付与されているプリンシパルの識別子。 必須です。
scheduleInfo requestSchedule グループの PIM のグループ メンバーシップまたは所有権の割り当ての期間。 定期的なスケジュールは現在サポートされていません。 必須。
ticketInfo ticketInfo チケット番号とチケット システムの詳細を含む、グループ メンバーシップまたは所有権の割り当て要求にリンクされているチケットの詳細。 省略可能。

応答

成功した場合、このメソッドは 201 Created 応答コードと、応答本文の privilegedAccessGroupAssignmentScheduleRequest オブジェクトを返します。

例

例 1: 割り当てスケジュール要求を作成する

次の要求は、指定したグループにプリンシパルのアクティブなメンバーシップを割り当てる割り当てスケジュール要求を作成します。 アクティブなメンバーシップは 2 時間後に期限切れになります。

要求

POST https://graph.microsoft.com/beta/identityGovernance/privilegedAccess/group/assignmentScheduleRequests
Content-Type: application/json

{
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "68e55cce-cf7e-4a2d-9046-3e4e75c4bfa7", 
  "action": "adminAssign", 
  "scheduleInfo": { 
      "startDateTime": "2022-12-08T07:43:00.000Z", 
      "expiration": { 
          "type": "afterDuration", 
          "duration": "PT2H" 
      } 
  }, 
  "justification": "Assign active member access."
}

応答

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

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "https://graph.microsoft.com/beta/$metadata#identityGovernance/privilegedAccess/group/assignmentScheduleRequests/$entity",
  "id": "34e963f6-150f-cf79-678c-6fcaf978bb49",
  "status": "Provisioned",
  "completedDateTime": "2023-02-07T07:05:55.3404527Z",
  "createdDateTime": "2023-02-07T07:05:53.7895614Z",
  "approvalId": null,
  "customData": null,
  "createdBy": {
      "user": {
          "id": "3cce9d87-3986-4f19-8335-7ed075408ca2"
      }
  },
  "action": "adminAssign",
  "isValidationOnly": false,
  "justification": "Assign active member access.",
  "scheduleInfo": {
      "startDateTime": "2023-02-07T07:05:55.3404527Z",
      "expiration": {
        "type": "afterDuration",
         "duration": "PT2H"
      }
  },
  "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
  },
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "68e55cce-cf7e-4a2d-9046-3e4e75c4bfa7",
  "targetScheduleId": "2b5ed229-4072-478d-9504-a047ebd4b07d_member_6aacaee8-4089-4048-9510-3119367fc943"
}

例 2: ユーザーがグループの PIM に対する適格な割り当てをアクティブにする

次の要求では、principalId3cce9d87-3986-4f19-8335-7ed075408ca2 で識別されたユーザーが、groupId2b5ed229-4072-478d-9504-a047ebd4b07d によって識別された PIM によって管理されるグループに対して適格なメンバーシップをアクティブ化します。

要求

POST https://graph.microsoft.com/beta/identityGovernance/privilegedAccess/group/assignmentScheduleRequests
Content-Type: application/json

{
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "2b5ed229-4072-478d-9504-a047ebd4b07d", 
  "action": "selfActivate", 
  "scheduleInfo": { 
      "startDateTime": "2023-02-08T07:43:00.000Z", 
      "expiration": { 
          "type": "afterDuration", 
          "duration": "PT2H" 
      } 
  }, 
  "justification": "Activate assignment."
}

応答

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

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "https://graph.microsoft.com/beta/$metadata#identityGovernance/privilegedAccess/group/assignmentScheduleRequests/$entity",
  "id": "6aacaee8-4089-4048-9510-3119367fc943",
  "status": "Provisioned",
  "completedDateTime": "2023-02-07T07:05:55.3404527Z",
  "createdDateTime": "2023-02-07T07:05:53.7895614Z",
  "approvalId": null,
  "customData": null,
  "createdBy": {
      "user": {
          "id": "3cce9d87-3986-4f19-8335-7ed075408ca2"
      }
  },
  "action": "selfActivate",
  "isValidationOnly": false,
  "justification": "Activate assignment.",
  "scheduleInfo": {
      "startDateTime": "2023-02-07T07:05:55.3404527Z",
      "expiration": {
        "type": "afterDuration",
         "duration": "PT2H"
      }
  },
  "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
  },
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "2b5ed229-4072-478d-9504-a047ebd4b07d",
  "targetScheduleId": "2b5ed229-4072-478d-9504-a047ebd4b07d_member_6aacaee8-4089-4048-9510-3119367fc943"
}