Создание roleEligibilityScheduleRequest

Пространство имен: microsoft.graph

В PIM запросите право на роль для субъекта с помощью объекта unifiedRoleEligibilityScheduleRequest . Эта операция позволяет администраторам и соответствующим пользователям добавлять, отзывать или расширять соответствующие назначения.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) RoleEligibilitySchedule.ReadWrite.Directory RoleManagement.ReadWrite.Directory
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение RoleManagement.ReadWrite.Directory Недоступно.

В делегированных сценариях пользователю, выполнившему вход, также необходимо назначить по крайней мере одну из следующих Microsoft Entra ролей:

  • Для операций чтения: глобальный читатель, оператор безопасности, читатель безопасности, администратор безопасности или администратор привилегированных ролей.
  • Для операций записи: администратор привилегированных ролей

HTTP-запрос

POST /roleManagement/directory/roleEligibilityScheduleRequests

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта unifiedRoleEligibilityScheduleRequest в формате JSON.

При создании unifiedRoleEligibilityScheduleRequest можно указать следующие свойства.

Свойство Тип Описание
action unifiedRoleScheduleRequestActions Представляет тип операции в запросе на получение ролей. Возможные значения: , , , , , , adminExtend, adminRenew, selfExtend, selfRenew. unknownFutureValueselfDeactivateselfActivateadminRemoveadminUpdateadminAssign
  • adminAssign: администраторы могут назначать соответствующие роли субъектам.
  • adminRemove: администраторы могут удалять соответствующие роли из субъектов.
  • adminUpdate: администраторы могут изменить существующие права на роль.
  • adminExtend: администраторы могут продлить срок действия ролей с истекающим сроком действия.
  • adminRenew: администраторы могут продлить срок действия.
  • selfActivate: для активации назначений пользователями.
  • selfDeactivate: пользователи могут деактивировать свои активные назначения.
  • selfExtend: пользователи могут запросить продление назначений с истекающим сроком действия.
  • SelfRenew: пользователи могут запросить продление просроченных назначений.
appScopeId String Идентификатор конкретного приложения область, когда допустимость роли ограничена приложением. Область допустимости роли определяет набор ресурсов, доступ к которым имеет субъект. Области приложения — это области, которые определяются и понимаются только этим приложением. Используйте / для областей приложений на уровне клиента. Используйте directoryScopeId, чтобы ограничить область определенными объектами каталога, например административными единицами. Требуется параметр directoryScopeId или appScopeId .
directoryScopeId String Идентификатор объекта каталога, представляющего область допустимости роли. Область допустимости роли определяет набор ресурсов, доступ к которым предоставлен субъекту. Области каталога — это общие области, хранящиеся в каталоге, которые понимаются несколькими приложениями. Используйте / для область на уровне клиента. Используйте appScopeId, чтобы ограничить область только приложением. Требуется параметр directoryScopeId или appScopeId .
isValidationOnly Логический Определяет, является ли вызов проверкой или фактическим вызовом. Задайте это свойство только в том случае, если вы хотите проверка, подчиняется ли активация дополнительным правилам, таким как MFA, перед фактической отправкой запроса. Необязательный параметр.
Обоснование String Сообщение, предоставляемое пользователями и администраторами при создании объекта unifiedRoleEligibilityScheduleRequest .

Необязательный для selfDeactivate действий иadminRemove; может быть необязательным или обязательным для других типов действий в зависимости от правил в политике, связанных с ролью Microsoft Entra. Дополнительные сведения см. в разделе Правила в PIM.
principalId String Идентификатор субъекта, которому было предоставлено право на роль. Обязательно.
roleDefinitionId String Идентификатор объекта unifiedRoleDefinition , который назначается субъекту. Обязательно.
scheduleInfo requestSchedule Период допустимости роли. Необязательный, если действие имеет значение adminRemove. Срок действия зависит от параметров Microsoft Entra роли.
ticketInfo ticketInfo Сведения о билетах, связанных с запросом на участие в роли, включая сведения о номере билета и системе билетов.

Необязательный для selfDeactivate действий иadminRemove; может быть необязательным или обязательным для других типов действий в зависимости от правил в политике, связанных с ролью Microsoft Entra. Дополнительные сведения см. в разделе Правила в PIM.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект unifiedRoleEligibilityScheduleRequest в тексте ответа.

Примеры

Пример 1. Администратор для назначения запроса на получение ролей

Запрос

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

{
    "action": "adminAssign",
    "justification": "Assign Attribute Assignment Admin eligibility to restricted user",
    "roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
    "directoryScopeId": "/",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "scheduleInfo": {
        "startDateTime": "2022-04-10T00:00:00Z",
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2024-04-10T00:00:00Z"
        }
    }
}

Отклик

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "50877283-9d40-433c-bab8-7986dc10458a",
    "status": "Provisioned",
    "createdDateTime": "2022-04-12T09:05:39.7594064Z",
    "completedDateTime": "2022-04-12T09:05:41.8532931Z",
    "approvalId": null,
    "customData": null,
    "action": "adminAssign",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": "50877283-9d40-433c-bab8-7986dc10458a",
    "justification": "Assign Attribute Assignment Admin eligibility to restricted user",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "3fbd929d-8c56-4462-851e-0eb9a7b3a2a5"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2022-04-12T09:05:41.8532931Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2024-04-10T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}

Пример 2. Администратор удаления существующего запроса на получение ролей

В следующем запросе администратор создает запрос на отмену права участника с идентификатором 071cc716-8147-4397-a5ba-b2105951cc0b на роль с идентификатором 8424c6f0-a189-499e-bbd0-26c1753c96d4.

Запрос

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

{
    "action": "adminRemove",
    "roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
    "directoryScopeId": "/",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b"
}

Отклик

Ниже показан пример отклика. Объект ответа показывает, что предыдущее право на роль для субъекта — .Revoked Субъект больше не будет видеть свою ранее допустимую роль.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "f341269e-c926-41fa-a905-cef3b01b2a67",
    "status": "Revoked",
    "createdDateTime": "2022-04-12T09:12:15.6859992Z",
    "completedDateTime": null,
    "approvalId": null,
    "customData": null,
    "action": "adminRemove",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": null,
    "justification": null,
    "scheduleInfo": null,
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "3fbd929d-8c56-4462-851e-0eb9a7b3a2a5"
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}