Список участников

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

Важно!

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

Используйте этот API для получения списка участников (пользователей, групп и устройств) в административной единице.

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

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

Разрешения

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

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

Примечание.

Чтобы просмотреть участников со скрытым членством в административной единице, приложению необходимо предоставить делегированное Member.Read.Hidden разрешение или разрешение приложения.

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

• Читатели каталогов
• Запись каталогов
• Администратор приложений
• Читатель сведений о безопасности
• Администратор безопасности
• Администратор привилегированных ролей
• Администратор облачного приложения
• Утверждающий доступ к lockBox клиента
• Администратор Dynamics 365
• Администратор Power BI
• Администратор Information Protection Azure
• Администратор Аналитика компьютеров
• Администратор лицензий
• Администратор компьютеров, управляемых Корпорацией Майкрософт
• Администратор связи Teams
• Инженер службы поддержки связи Teams
• Специалист службы поддержки связи Teams
• Администратор Teams
• Администратор Insights
• Администратор данных соответствия требованиям
• Оператор безопасности
• Администратор Kaizala
• Глобальный читатель
• Рецензент каталога

Когда приложение запрашивает связь, которая возвращает коллекцию типов directoryObject , если у него нет разрешения на чтение определенного производного типа (например, устройство), возвращаются члены этого типа, но с ограниченной информацией. При таком поведении приложения могут запрашивать необходимые разрешения с наименьшими привилегиями, а не полагаться на набор каталогов.*Разрешения. Сведения см. в разделе Ограниченные сведения, возвращаемые для недоступных объектов member.

HTTP-запрос

GET /administrativeUnits/{id}/members
GET /administrativeUnits/{id}/members/$ref

Необязательные параметры запросов

Этот метод (при использовании без $ref) поддерживает параметры запроса OData для настройки ответа, включая $search, $countи $filter. Приведение OData также включено, например, можно выполнить приведение, чтобы получить только пользователей, которые являются членами административной единицы.

$search поддерживается только в свойствах displayName и description . Некоторые запросы поддерживаются только при использовании заголовка ConsistencyLevel с присвоенным значением eventual и $count. Дополнительные сведения см. в разделе Расширенные возможности запросов к объектам каталогов.

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

Заголовок	Значение
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
ConsistencyLevel	необязательный. Этот заголовок и $count требуются при использовании $search или определенном использовании $filter. Дополнительные сведения об использовании ConsistencyLevel и $countсм. в разделе Дополнительные возможности запросов к объектам каталога.

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

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов пользователя, группы или устройства в тексте отклика. Добавление $ref в конце запроса возвращает коллекцию только @odata.id URL-адресов членов.

Примеры

Пример 1. Вывод списка объектов-членов

Запрос

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

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members

Отклик

Ниже показан пример отклика.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "value":[
    {
      "@odata.type":"#microsoft.graph.user",
      "id":"492c5308-59fd-4740-9c83-4b3db07a6d70"
      "accountEnabled":true,
      "businessPhones":[],
      "companyName":null,
      "displayName":"Demo User"
    },
    {
      "@odata.type":"#microsoft.graph.group",
      "id":"07eaa5c7-c9b6-45cf-8ff7-3147d5122caa",
      "description":"This group is the best ever",
      "displayName":"Awesome group"
    }
  ]
}

Пример 2. Перечисление ссылок на участников

Запрос

Следующий запрос выводит список ссылок на элементы административной единицы, возвращая коллекцию @odata.id ссылок на члены.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref

Отклик

Ниже показан пример отклика.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "value":[
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
    },
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
    }
  ]
}