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

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

Получение списка непосредственных участников группы. Участниками группы могут быть пользователи, контакты организации, устройства, субъекты-службы и другие группы. В настоящее время субъекты-службы не указаны как участники группы благодаря поэтапному развертыванию субъектов-служб в конечной точке Microsoft Graph версии 1.0. Эта операция не является транзитивной.

Если группа содержит более 100 участников, Microsoft Graph возвращает в отклике свойство @odata.nextLink, содержащее URL-адрес следующей страницы результатов. При наличии этого свойства продолжайте выполнять дополнительные запросы с URL-адресом @odata.nextLink в каждом отклике, пока не будут возвращены все результаты, как описано в статье Разбиение данных Microsoft Graph по страницам в приложении.

Разрешения

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

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

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

HTTP-запрос

GET /groups/{id}/members

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

Этот метод поддерживает параметры запросов OData для настройки ответа, в том числе $search, $count і $filter. Кроме того, включено приведение к OData, например, вы можете получить только пользователей, которые являются участниками группы. Вы можете использовать $search в свойствах displayName и description. Когда элементы добавляются или обновляются для этого ресурса, они специально индексируются для использования с помощью параметров $count и $search. Между добавлением или обновлением элемента и его появлением в индексе может возникать небольшая задержка.

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

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

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

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

Отклик

В случае успеха этот метод возвращает код отклика 200 OK и коллекцию объектов directoryObject в тексте отклика.

Примеры

Пример 1. Получение сведений о непосредственном участии в группе

Запрос

Ниже приведен пример запроса.

GET https://graph.microsoft.com/v1.0/groups/{id}/members

Отклик

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "mail": "user1@contoso.com"
    }
  ]
}

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

Запрос

Ниже приведен пример запроса.

GET https://graph.microsoft.com/v1.0/groups/{id}/members/$count
ConsistencyLevel: eventual

Отклик

Ниже приведен пример ответа.

HTTP/1.1 200 OK
Content-type: text/plain

893

Пример 3. Использование приведения к OData для получения только количества участий пользователей

Запрос

Ниже приведен пример запроса.

GET https://graph.microsoft.com/v1.0/groups/{id}/members/microsoft.graph.user/$count
ConsistencyLevel: eventual

Отклик

Ниже приведен пример ответа.

HTTP/1.1 200 OK
Content-type: text/plain

893

Пример 4. Использование приведения к OData и параметра $search для получения участия пользователей в группах с отображаемыми именами, содержащими буквы "Pr", включая количество возвращаемых объектов

Запрос

Ниже приведен пример запроса.

GET https://graph.microsoft.com/v1.0/groups/{id}/members/microsoft.graph.user?$count=true&$orderby=displayName&$search="displayName:Pr"&$select=displayName,id
ConsistencyLevel: eventual

Отклик

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

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users(displayName,id)",
  "@odata.count":7,
  "value":[
    {
      "displayName":"Joseph Price",
      "id":"11111111-2222-3333-4444-555555555555"
    },
    {
      "displayName":"Preston Morales",
      "id":"66666666-7777-8888-9999-000000000000"
    }
  ]
}

Пример 5. Использование параметра $filter для получения участия в группах с отображаемым именем, которое начинается на "А", включая количество возвращаемых объектов

Запрос

Ниже приведен пример запроса.

GET https://graph.microsoft.com/v1.0/groups/{id}/members?$count=true&$filter=startswith(displayName, 'a')
ConsistencyLevel: eventual

Отклик

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

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Users",
      "mail":"AADContoso_Users@contoso.com"
    }
  ]
}