Перечисление участников группы

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

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

Важно!

У этого API есть известная проблема, из-за которой субъекты-службы не указаны как участники группы в версии 1.0. В качестве обходного решения используйте этот API на конечной точке beta или используйте /groups/{id}?$expand=members API. Дополнительные сведения см. в описании соответствующей известной проблемы.

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

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

Разрешения

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

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

Важно!

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

В делегированных сценариях вошедшему пользователю также должна быть назначена поддерживаемая роль Microsoft Entra или пользовательская роль с microsoft.directory/groups/members/read разрешением "Роль илиmicrosoft.directory/groups/members/limitedRead" или microsoft.directory/groups/hiddenMembers/read "Разрешение роли на чтение скрытых участников". Для этой операции поддерживаются следующие роли с минимальными привилегиями:

  • Владельцы группы
  • Пользователи-участники
  • "Гостевые" пользователи имеют ограниченные разрешения на чтение
  • Средства чтения каталогов
  • Запись каталогов
  • Администратор групп
  • Администратор пользователей — включая скрытых участников
  • Администратор Exchange — включая скрытых участников
  • Администратор SharePoint — включая скрытых участников
  • Администратор Intune — включая скрытых участников
  • Администратор Teams — включая скрытых участников
  • Администратор Yammer — включая скрытых участников

Чтобы вывести список участников скрытой группы, также требуется разрешение Member.Read.Hidden.

HTTP-запрос

GET /groups/{id}/members

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

Этот метод поддерживает параметры запросов $filter, $count, $select, $search, $topи $expandOData, что помогает настраивать ответ.

  • Приведение OData включено. Например, /groups/{id}/members/microsoft.graph.user получает участников группы, которые являются пользователями.
  • $search поддерживается только для свойств displayName и description .
  • Использование параметров запроса с этим API, за исключением $expand, поддерживается только с расширенными параметрами запроса. $expand не поддерживается расширенными параметрами запроса. Дополнительные сведения см. в статье Расширенные возможности запросов для объектов каталога.

По умолчанию максимальный размер страницы составляет 100 и 999 объектов группы соответственно.

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

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

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

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

Отклик

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

Попытка фильтрации по приведению OData, представляющему неподдерживаемый тип члена, возвращает 400 Bad Request ошибку с Request_UnsupportedQuery кодом. Например, /groups/{id}}/members/microsoft.graph.group если группа является группой Microsoft 365, эта ошибка возникает, так как группы Microsoft 365 не могут иметь другие группы в качестве участников.

Примеры

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

Запрос

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

GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/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/02bd9fd6-8f93-4758-87c3-1fb73740a315/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"
    }
  ]
}