フィードバック 編集

roleEligibilityScheduleRequests を作成する

  • [アーティクル]

名前空間: microsoft.graph

重要

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

新しい unifiedRoleEligibilityScheduleRequest オブジェクトを 作成します。 この操作により、管理者と対象ユーザーの両方が、対象となる割り当ての追加、取り消し、または延長を行うことができます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) RoleEligibilitySchedule.ReadWrite.Directory
委任 (個人用 Microsoft アカウント) サポートされていません
Application サポート対象外

HTTP 要求

POST /roleManagement/directory/roleEligibilityScheduleRequests

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
Content-Type application/json. Required.

要求本文

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

次の表は、 unifiedRoleEligibilityScheduleRequest を作成するときに必要な省略可能なプロパティを示しています。

プロパティ 型 説明
action String ロールの適格性の割り当てに対する操作の種類を表します。 値は次のいずれかです。
  • AdminAssign: 管理者がロールにロールの適格性をユーザーまたはグループに割り当てる場合。
  • AdminExtend: 管理者が期限切れの割り当てを拡張する場合。
  • AdminUpdate: 管理者が既存のロールの割り当てを変更する場合。
  • AdminRenew: 管理者が期限切れの割り当てを更新する場合。
  • AdminRemove: 管理者が対象ロールからユーザーまたはグループを削除する場合。
  • UserAdd: ユーザーが対象の割り当てをアクティブ化するため。
  • UserExtend: 期限切れの対象となる割り当ての延長を要求するユーザー。
  • UserRemove: ユーザーがアクティブな適格な割り当てを非アクティブ化する場合。
  • UserRenew: 期限切れの対象となる割り当ての更新をユーザーが要求する場合。
appScopeId String 割り当てスコープがアプリ固有の場合のアプリ固有のスコープの識別子。 割り当てのスコープによって、プリンシパルにアクセスが許可されているリソースのセットが決まります。 アプリ スコープは、このアプリケーションによってのみ定義され、理解されるスコープです。 テナント全体のアプリ スコープに使用 / します。 directoryScopeId を使用して、管理単位やすべてのユーザーなど、特定のディレクトリ オブジェクトにスコープを制限します。
directoryScopeId String 割り当てのスコープを表すディレクトリ オブジェクトの識別子。 割り当てのスコープによって、プリンシパルにアクセスが許可されているリソースのセットが決まります。 ディレクトリ スコープは、複数のアプリケーションによって認識されるディレクトリに格納されている共有スコープです。 テナント全体のスコープに使用 / します。 appScopeId を使用して、スコープをアプリケーションのみに制限します。
isValidationOnly Boolean 呼び出しが検証か実際の呼び出しかを決定するブール値。 このプロパティは、実際に要求を送信する前に、アクティブ化が MFA などの追加規則の対象かどうかを確認する場合にのみ設定します。
正当 化 String 必要な理由に関する要求を作成するときに、ユーザーと管理者から提供されるメッセージ。 アクション が AdminRemove.
principalId String 割り当てが付与されているプリンシパルの識別子。 たとえば、ユーザーやグループなどです。 グループの場合は、ロールに割り当て可能である必要があります。つまり、グループ プロパティの isAssignableToRole が .true
roleDefinitionId String 割り当ての対象となる unifiedRoleDefinition の識別子。 必須です。 読み取り専用です。
scheduleInfo requestSchedule ロール割り当て要求の schedule オブジェクト。 このプロパティは、アクションAdminRemoveが .
ticketInfo ticketInfo チケット番号とチケット システムの詳細を含む、ロールの割り当て要求にアタッチされた ticketInfo オブジェクト。 省略可能。

応答

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

例

例 1: 管理者がロールの適格性スケジュール要求を割り当てる

次の要求では、管理者は ID でfdd7a751-b60b-444a-984c-02652fe8fa1c識別されたプリンシパルに、識別されたロールの適格性を割り当てる要求を作成 します07706ff1-46c7-4847-ae33-3003830675a1。 適格性の範囲は、2022 年 6 月 30 日午前 0 時 (UTC 時間) まで、テナント内のすべてのディレクトリ オブジェクトです。

要求

POST https://graph.microsoft.com/beta/roleManagement/directory/roleEligibilityScheduleRequests
Content-Type: application/json

{
  "action": "AdminAssign",
  "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
  "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
  "directoryScopeId": "/",
  "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
  "scheduleInfo": {
    "startDateTime": "2021-07-01T00:00:00Z",
    "expiration": {
      "endDateTime": "2022-06-30T00:00:00Z",
      "type": "AfterDateTime"
    }
  }
}

応答

応答の例を次に示します。

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "672c03bf-226a-42ec-a8b7-3bfab96064a1",
    "status": "Provisioned",
    "createdDateTime": "2021-07-26T18:08:03.1299669Z",
    "completedDateTime": "2021-07-26T18:08:06.2081758Z",
    "approvalId": null,
    "customData": null,
    "action": "AdminAssign",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": "672c03bf-226a-42ec-a8b7-3bfab96064a1",
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "fc9a2c2b-1ddc-486d-a211-5fe8ca77fa1f"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2022-06-30T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}

例 2: 既存のロールの適格性スケジュール要求を削除する管理者

次の要求では、管理者は ID 07706ff1-46c7-4847-ae33-3003830675a1で識別されたプリンシパルによってfdd7a751-b60b-444a-984c-02652fe8fa1c識別されるロールの適格性を取り消す要求を作成します。

要求

POST https://graph.microsoft.com/beta/roleManagement/directory/roleEligibilityScheduleRequests
Content-Type: application/json

{
    "action": "AdminRemove",
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "expiration": {
            "endDateTime": "2022-06-30T00:00:00Z",
            "type": "AfterDateTime"
        }
    }
}

応答

応答の例を次に示します。 要求は、以前に適格な割り当ての変更 Revokedの状態を示す応答オブジェクトを返します。 プリンシパルには、以前に適格なロールが表示されなくなります。

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "7f88a144-f9a9-4f8c-9623-39c321ae93c2",
    "status": "Revoked",
    "createdDateTime": "2021-08-06T17:59:12.4263499Z",
    "completedDateTime": null,
    "approvalId": null,
    "customData": null,
    "action": "AdminRemove",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": null,
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "fc9a2c2b-1ddc-486d-a211-5fe8ca77fa1f"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2022-06-30T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}