Тип ресурса directoryRole
Пространство имен: microsoft.graph
Примечание.
Корпорация Майкрософт рекомендует использовать вместо этого API унифицированный API RBAC. Единый API RBAC обеспечивает большую функциональность и гибкость. Дополнительные сведения см. в разделе Тип ресурса unifiedRoleDefinition.
Представляет роль каталога Microsoft Entra. Microsoft Entra роли каталога также называются ролями администратора. Дополнительные сведения о ролях каталога (администратора) см. в разделе Назначение Microsoft Entra ролей администратора. С помощью Microsoft Graph можно назначать пользователям роли каталога, чтобы предоставить им разрешения целевой роли. Чтобы можно было считать роль каталога или обновить ее членов, сначала следует активировать ее на клиенте. По умолчанию активируется только роль каталога администраторов организации. Чтобы активировать остальные доступные роли каталога, следует отправить запрос POST с идентификатором ресурса directoryRoleTemplate, определяющего значения свойств для роли каталога. Перечислите шаблоны для ролей каталогов, чтобы получить все остальные доступные роли каталогов. Наследуется от directoryObject.
Этот ресурс поддерживает:
- отслеживание дополнений, удалений и обновлений с помощью запроса изменений (функция delta).
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Получение роли каталога | directoryRole | Считывание свойств и отношений объекта directoryRole. |
| Список ролей каталога | Коллекция объектов directoryRole | Перечисление ролей каталога, активированных в клиенте. |
| Добавление элемента | directoryObject | Добавление пользователя в роль каталога путем записи данных в свойство навигации members. |
| Список членов | Коллекция directoryObject | Получение пользователей, которые относятся к членам роли каталога, из свойства навигации members. |
| Удаление участника | directoryObject | Удаление ресурса user из роли каталога. |
| Активация роли каталога | directoryRole | Активация роли каталога. |
| Вывод списка элементов с заданной областью | Коллекция scopedRoleMembership | Перечисление участников этой роли каталога, относящихся к области административных единиц, с помощью коллекции ресурсов scopedRoleMembership. |
| Получение дельты | Коллекция объектов 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"
}