Тип ресурса directoryRole

  • Статья

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Представляет роль каталога Microsoft Entra. Microsoft Entra роли каталога также называются ролями администратора. Дополнительные сведения о ролях каталога (администратора) см. в разделе Назначение ролей администратора в Microsoft Entra ID. С помощью Microsoft Graph можно назначать пользователям роли каталога, чтобы предоставить им разрешения целевой роли. Чтобы можно было считать роль каталога или обновить ее членов, сначала следует активировать ее на клиенте. По умолчанию активируется только роль каталога администраторов организации. Чтобы активировать другие доступные роли каталога, отправьте запрос POST с идентификатором каталогаRoleTemplate , на котором основана роль каталога. Перечислите шаблоны для ролей каталогов, чтобы получить все остальные доступные роли каталогов. Наследуется от directoryObject.

По умолчанию для ролей каталогов задана область действия на уровне клиента. Однако роли каталогов (в настоящее время только администратор учетной записи пользователя и администратор службы поддержки) также могут быть ограничены административными единицами.

Этот ресурс поддерживает:

Методы

Метод Возвращаемый тип Описание
Получение directoryRole directoryRole Считывание свойств и отношений объекта directoryRole.
Перечисление объектов directoryRole Коллекция объектов directoryRole Перечисление ролей каталога, активированных в клиенте.
Добавление элемента directoryObject Добавление пользователя в роль каталога путем записи данных в свойство навигации members.
Список членов Коллекция directoryObject Получение пользователей, которые относятся к членам роли каталога, из свойства навигации members.
Удаление члена directoryObject Удаление ресурса user из роли каталога.
Активация directoryRole directoryRole Активация роли каталога.
Список элементов scopeMembers Коллекция scopedRoleMembership Перечисление участников этой роли каталога, относящихся к области административных единиц, с помощью коллекции ресурсов scopedRoleMembership.
delta Коллекция объектов directoryRole Получение добавочных изменений для ролей каталога.

Свойства

Свойство Тип Описание
description Строка Описание роли каталога. Только для чтения. Поддерживает $filter (eq), $search, $select.
displayName Строка Отображаемое имя роли каталога. Только для чтения. Поддерживает $filter (eq), $search, $select.
id String Уникальный идентификатор роли каталога. Наследуется из directoryObject. Ключ, значение null не допускается, только для чтения. Поддерживает $filter (eq), $select.
roleTemplateId String Свойство id ресурса directoryRoleTemplate, определяющего значения свойств для этой роли. При активации роли каталога на клиенте следует указать свойство с помощью операции POST. После активации роли каталога свойство доступно только для чтения. Поддерживает $filter (eq), $select.

Связи

Связь Тип Описание
members Коллекция directoryObject Пользователи, которые относятся к членам этой роли каталога. Методы HTTP: GET, POST, DELETE. Только для чтения. Допускается значение null. Поддерживает $expand.
scopedMembers Коллекция scopedRoleMembership Участники роли каталога, относящихся к области административных единиц. Только для чтения. Допускается значение null.

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "roleTemplateId": "string"
}