Тип ресурса group
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет группу Microsoft Entra, которая может быть группой Microsoft 365, командой в Microsoft Teams или группой безопасности. Этот ресурс относится к открытому типу, который позволяет передавать другие свойства.
Наследуется от directoryObject.
Чтобы повысить производительность, операции create, get и list возвращают только подмножество часто используемых свойств по умолчанию. Эти свойства по умолчанию указаны в разделе Свойства. Чтобы получить любое из свойств, не возвращенных по умолчанию, укажите их в параметре $select
запроса OData.
Этот ресурс поддерживает:
- Добавление данных в пользовательские свойства в качестве расширений.
- подписку на уведомления об изменениях;
- отслеживание дополнений, удалений и обновлений с помощью запроса изменений (функция delta).
Команды Microsoft Teams и группы Microsoft 365 поддерживают групповое взаимодействие. С Microsoft Teams можно использовать большинство API групп Microsoft 365. Чтобы создать команду, сначала создайте группу, а затем добавьте к ней команду. Дополнительные сведения см. в обзоре Microsoft Teams.
Методы
Метод | Возвращаемый тип | Описание |
---|---|---|
Список | Коллекция group | Чтение свойств и связей всех объектов group. |
Создание | group | Создание указанной группы. Это может быть группа Microsoft 365, группа безопасности, динамическая группа или команда. |
Получение | group | Чтение свойств и связей объекта group. |
Обновление | Нет | Обновление свойств объекта group. |
удаление; | Нет | Удаление объекта group. |
Получение дельты | Коллекция group | Получение добавочных изменений для групп. |
Upsert | group | Создайте новую группу, если она не существует, или обновите свойства существующей группы. |
Управление группами | ||
Перечисление участников | Коллекция directoryObject | Получение пользователей и групп, являющихся непосредственными участниками этой группы, из свойства навигации members. |
Добавление участника | directoryObject | Добавьте участника в эту группу, опубликовав его в свойстве навигации members (поддерживается только для групп безопасности и групп Microsoft 365). |
Удаление участника | Нет | Удаление участника из группы Microsoft 365 или группы безопасности с помощью свойства навигации members. |
Список владельцев | Коллекция directoryObject | Получение владельцев группы из свойства навигации owners. |
Добавление владельца | directoryObject | Добавление владельца группы путем помещения в свойство навигации owners (поддерживается только для групп безопасности и групп Microsoft 365). |
Удаление владельца | Нет | Удаление владельца из группы Microsoft 365 или группы безопасности с помощью свойства навигации owners. |
Перечисление конечных точек | Коллекция endpoint | Получение коллекции объектов endpoint. |
Получение конечной точки | endpoint | Чтение свойств и связей объекта endpoint. |
Список свойств member of | Коллекция directoryObject | Получение групп и административных единиц, непосредственным участником которых является группа, из свойства навигации memberOf. |
Перечисление политик жизненного цикла группы | Коллекция groupLifecyclePolicy | Перечисление политик жизненного цикла для групп. |
Перечисление транзитивных участников | Коллекция directoryObject | Получение пользователей, групп, устройств и субъектов-служб, являющихся участниками, включая вложенных участников этой группы |
Перечисление транзитивного элемента | Коллекция directoryObject | Перечисление групп и административных единиц, в которых состоит группа. Эта операция является транзитивной и включает группы, в которых эта группа является вложенным элементом. |
Назначение лицензии | group | Добавление или удаление подписок группы. Вы также можете включать и отключать отдельные планы, связанные с подпиской. |
Оценка динамического членства | evaluateDynamicMembershipResult | Определите, может ли пользователь или устройство являться членом динамической группы. |
Renew | Логический | Обновляет срок действия группы. Когда группа обновляется, срок ее действия продляется на количество дней, определенное политикой. |
Проверка свойств | JSON | Проверьте отображаемое имя или псевдоним электронной почты группы Microsoft 365, которые соответствуют политикам именования. |
Назначение ролей приложений | ||
List | Коллекция appRoleAssignment | Получение приложений и ролей приложений, которым назначена эта группа. |
Добавление | appRoleAssignment | Назначение роли приложения группе. |
Remove | Нет. | Удаление назначения роли приложения из группы. |
Calendar | ||
Получение календаря | calendar | Получение календаря группы. |
Обновление календаря | Нет | Обновите календарь группы. |
Получение списка событий | Коллекция event | Получение коллекции объектов event. |
Создание события | event | Создание объекта event путем публикации в коллекции объектов event. |
Получение события | event | Считывание свойств объекта event. |
Обновление события | Нет | Обновление свойств объекта event. |
Удаление события | Нет | Удаление объекта event. |
Список представлений календаря | Коллекция event | Получение коллекции событий за указанный интервал времени. |
Беседы | ||
Перечисление бесед | Коллекция conversation | Получение коллекции объектов conversation. |
Создание беседы | conversation | Создание беседы путем публикации в коллекции объектов conversation. |
Получение беседы | conversation | Считывание свойств объекта conversation. |
Удаление беседы | Нет | Удаление объекта conversation. |
Перечисление цепочек | Коллекция conversationThread | Получение всех цепочек группы. |
Создание цепочки | conversationThread | Создание цепочки беседы. |
Получение цепочки | conversationThread | Считывание свойств объекта thread. |
Обновление цепочки | Нет | Обновление свойств объекта thread. |
Удаление цепочки | Нет | Удаление объекта thread |
Вывод списка разрешенных отправителей | Коллекция directoryObject | Получение списка пользователей или групп, включенных в список утвержденных отправителей для этой группы. |
Добавление принятого отправителя | directoryObject | Добавление User или Group в коллекцию acceptedSenders. |
Удаление разрешенного отправителя | directoryObject | Удаление User или Group из коллекции acceptedSenders. |
Список отклоненных отправителей | Коллекция directoryObject | Получение списка пользователей или групп, включенных в список запрещенных отправителей для этой группы. |
Добавление отклоненного отправителя | directoryObject | Добавление User или Group в коллекцию rejectedSenders. |
Удаление отклоненного отправителя | directoryObject | Удаление нового объекта User или Group из коллекции объектов rejectedSender. |
Объекты каталога | ||
Перечисление удаленных элементов | Коллекция directoryObject | Получение групп, удаленных в клиенте за последние 30 дней. |
Получение удаленного элемента | Коллекция directoryObject | Получение удаленной группы по идентификатору. |
Восстановление удаленного элемента | Коллекция directoryObject | Восстановление группы, удаленной в клиенте за последние 30 дней. |
Удаление элемента без возможности восстановления | Коллекция directoryObject | Окончательное удаление группы из клиента. |
Перечисление удаленных элементов, принадлежащих пользователю | Коллекция directoryObject | Получите группы, удаленные в клиенте за последние 30 дней, которые принадлежат пользователю. |
Проверка членства в группах | Коллекция строк | Проверка членства в списке групп. Это транзитивная функция. |
Получение групп пользователя | Коллекция строк | Возвращает все группы, в которые входит группа. Это транзитивная функция. |
Проверка объектов-членов | Коллекция String | Проверка участия в списке группы, роли каталога или объектах административных единиц. Это транзитивная функция. |
Вывод объектов членства | Коллекция строк | Возвращает все группы и административные единицы, в которые входит группа. Это транзитивная функция. |
Drive | ||
Получение объекта drive | drive | Получение свойств и связей ресурса Drive. |
Список дочерних элементов | Коллекция driveItem | Возвращает коллекцию объектов driveItem в связи дочерних элементов объекта driveItem. |
Параметры группы | ||
List | Коллекция directorySetting | Перечисление свойств всех объектов setting. |
Создание | directorySetting | Создайте объект параметра на основе каталогаSettingTemplate. Запрос POST должен предоставить settingValues для всех параметров, определенных в шаблоне. Для этой операции можно использовать только шаблоны для групп. |
Получение | directorySetting | Считывание свойств определенного объекта setting. |
Обновление | Нет | Обновление объекта параметра. |
удаление; | Нет | Удаление объекта setting. |
Список шаблонов параметров | Нет | Перечисление свойств всех шаблонов параметров. |
Получение шаблона параметров | Нет | Чтение свойств шаблона параметров. |
Примечания. | ||
Список записных книжек | Коллекция объектов notebook | Получение списка объектов notebook. |
Создание записной книжки | notebook | Создание записной книжки OneNote. |
Учетные данные единого входа на основе пароля | ||
Получение | коллекция passwordSingleSignOnCredentialSet | Получите список учетных данных единого входа на основе пароля для этой группы. Пароли никогда не возвращаются, а вместо этого всегда возвращаются как null. |
удаление; | Нет | Удалите учетные данные единого входа на основе пароля для заданного субъекта-службы, связанного с этой группой. |
имя. | ||
Фотография профиля | ||
Получение | profilePhoto | Получение указанного объекта profilePhoto или его метаданных (свойств profilePhoto). |
Обновление | Нет | Обновление фотографии любого пользователя в клиенте, в том числе пользователя, выполнившего вход, либо указанной группы или контакта. |
удаление; | Нет | Удалите фотографию любого пользователя в клиенте, включая пользователя, выполнившего вход, или указанную группу. |
Планировщик | ||
Список планов | Коллекция объектов plannerPlan | Получение планов, назначенных группе. |
Posts | ||
List | Коллекция post | Получение записей в потоке беседы. |
получение; | post | Получите определенную запись. |
Ответить на публикацию | Нет | Ответ на сообщение. |
Пересылка записи | Нет | Пересылать сообщение. |
Другие ресурсы групп | ||
Перечисление предоставленных разрешений | Коллекция resourceSpecificPermissionGrant | Список разрешений, предоставленных приложениям для доступа к группе. |
Параметры пользователя | ||
Добавление в избранное | Нет | Добавление группы в список избранных групп вошедшего пользователя. Поддерживается только для групп Microsoft 365. |
Удаление из избранного | Нет | Удаление группы из списка избранных групп вошедшего пользователя. Поддерживается только для групп Microsoft 365. |
Список свойств member of | Коллекция directoryObject | Получите группы и административные единицы, в которые этот пользователь является непосредственным членом, из свойства навигации memberOf . |
Список групп, к которым присоединился пользователь | Коллекция group | Получение команд Microsoft Teams, непосредственным участником которых является пользователь. |
Перечисление связанных команд | коллекция associatedTeamInfo | Получите список объектов associatedTeamInfo в Microsoft Teams, с которыми связан пользователь. |
Подписка по почте | Нет | Задает для свойства isSubscribedByMail значение true . Позволяет вошедшему пользователю получать беседы по электронной почте. Поддерживается только для групп Microsoft 365. |
Отмена подписки по почте | Нет | Задает для свойства isSubscribedByMail значение false . Отключение вошедшего в систему пользователя от получения сообщений электронной почты. Поддерживается только для групп Microsoft 365. |
Сброс количества непросмотренных элементов | Нет | Сбросьте значение unseenCount до 0 для всех записей, которые пользователь не видел с момента последнего посещения. Поддерживается только для групп Microsoft 365. |
Свойства
Важно!
Определенное использование $filter
и параметра запроса $search
поддерживается только при применении заголовка ConsistencyLevel с присвоенным значением eventual
и $count
. Дополнительные сведения см. в разделе Расширенные возможности запросов к объектам каталогов.
Свойство | Тип | Описание |
---|---|---|
accessType | groupAccessType | Указывает тип доступа к группе. Возможные значения: none , private , secret и public . |
allowExternalSenders | Логический | Указывает, могут ли пользователи за пределами организации отправлять сообщения в группу. Значение по умолчанию — false . Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). |
assignedLabels | Коллекция assignedLabel | Список пар меток конфиденциальности (идентификатор метки, имя метки), связанных с группой Microsoft 365. Возвращается только с помощью оператора $select . Это свойство можно обновить только в делегированных сценариях, когда вызывающей стороне требуется разрешение Microsoft Graph и поддерживаемая роль администратора. |
assignedLicenses | Коллекция assignedLicense | Лицензии, назначенные группе. Возвращается только с помощью оператора $select . Поддерживает $filter (eq ). Только для чтения. |
autoSubscribeNewMembers | Логический | Указывает, что новые участники, добавленные в группу, автоматически подписаны на получение Уведомления по электронной почте. Это свойство можно задать в запросе PATCH для группы; Не устанавливайте его в первоначальном запросе POST, который создает группу. Значение по умолчанию — false . Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). |
classification | String | Описывает классификацию для группы (например, низкий, средний или высокий уровень влияния на бизнес). Допустимые значения для этого свойства определяются путем создания значения параметра ClassificationList на основе определения шаблона. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , startsWith ). |
createdByAppId | String | Идентификатор приложения, использованного для создания группы. Для некоторых групп может иметь значение NULL. Возвращается по умолчанию. Только для чтения. Поддерживает $filter (eq , ne , not , in , startsWith ). |
createdDateTime | DateTimeOffset | Метка времени создания группы. Значение не может быть изменено и автоматически заполняется при создании группы. Тип Timestamp представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z . Возвращается по умолчанию. Только для чтения. |
deletedDateTime | DateTimeOffset | Для некоторых Microsoft Entra объектов (пользователя, группы, приложения), если объект удален, сначала он логически удаляется, и это свойство обновляется с учетом даты и времени удаления объекта. В противном случае это свойство имеет значение null. При восстановлении объекта это свойство обновляется до null . Наследуется от directoryObject. |
description | String | Необязательное описание для группы. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , startsWith ) и $search . |
displayName | String | Отображаемое имя для группы. Обязательный. Максимальная длина: 256 символов. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , in , startsWith и eq для значений null ), $search и $orderby . |
expirationDateTime | DateTimeOffset | Метка времени завершения срока действия группы. Он предназначен null для групп безопасности, но для групп Microsoft 365 представляет, когда срок действия группы истекает, как определено в groupLifecyclePolicycy. Тип Timestamp представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z . Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , in ). Только для чтения. |
groupTypes | Коллекция String | Задает тип группы и участие в ней. Если коллекция содержит Unified , группа является группой Microsoft 365; в противном случае это группа безопасности или группа рассылки. Дополнительные сведения см. в статье Обзор групп.Если коллекция включает объект DynamicMembership , в этой группе используется динамическое участие. В противном случае участие является статическим. Возвращается по умолчанию. Поддерживает $filter (eq , not ). |
hasMembersWithLicenseErrors | Логический | Указывает, есть ли в этой группе участники с ошибками лицензий после группового назначения лицензий. Это свойство никогда не возвращается при использовании операции GET. Его можно использовать в качестве аргумента $filter для получения групп, включающих участников с ошибками лицензии (т. е. фильтру для этого свойства присвоено значчение true ). Поддерживает $filter (eq ). |
hideFromAddressLists | Логический |
true Значение , если группа не отображается в определенных частях пользовательского интерфейса Outlook: в адресной книге, в списках адресов для выбора получателей сообщений и в диалоговом окне Обзор Группы для поиска групп; в противном случае значение false. Значение по умолчанию — false . Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). |
hideFromOutlookClients | Логический |
true Если группа не отображается в клиентах Outlook, таких как Outlook для Windows и Outlook в Интернете, в противном случае значение false. Значение по умолчанию — false . Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). |
id | String | Уникальный идентификатор группы. Возвращается по умолчанию. Наследуется от directoryObject. Ключ. Значение null не допускается. Только для чтения. Поддерживает $filter (eq , ne , not , in ). |
isArchived | Boolean | Когда группа связана с командой, это свойство определяет, находится ли команда в режиме "только для чтения". Чтобы прочитать это свойство, используйте конечную точку /group/{groupId}/team или API получения сведений о команде. Чтобы обновить это свойство, используйте API archiveTeam и unarchiveTeam. |
isAssignableToRole | Логическое | Указывает, может ли эта группа быть назначена Microsoft Entra роли. Необязательный параметр. Это свойство можно настроить только при создании группы, и оно является неизменяемым. Если задано значение true , свойство securityEnabled также должно иметь значение true , видимость должна иметь значение Hidden , а группа не может быть динамической группой (то есть groupTypes не может содержать DynamicMembership ). Это свойство могут задавать только вызывающие абоненты с ролью администратора привилегированных ролей. Вызывающему также должно быть назначено разрешение RoleManagement.ReadWrite.Directory , чтобы задать это свойство или обновить членство в таких группах. Дополнительные сведения см. в статье Использование группы для управления Microsoft Entra назначениями ролей. Для использования этой функции требуется лицензия Microsoft Entra ID P1. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not ). |
isFavorite | Boolean | Указывает, помечает ли пользователь группу как избранное. |
isManagementRestricted | Логический | Указывает, является ли группа членом административной единицы управления с ограниченным доступом. Значение по умолчанию — false . Только для чтения. Чтобы управлять членом группы административной единицы управления с ограниченным доступом, администратору или вызывающему приложению должна быть назначена роль Microsoft Entra на область административной единицы ограниченного управления. |
infoCatalogs | Коллекция объектов string | Определяет сегменты сведений, назначенные группе. Возвращается по умолчанию. Поддерживает $filter (eq , not , ge , le , startsWith ). |
isSubscribedByMail | Логический | Указывает, подписан ли вошедший пользователь на получение бесед по электронной почте. Значение по умолчанию — true . Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). |
licenseProcessingState | String | Указывает состояние назначения лицензии группы всем участникам группы. Возможные значения: QueuedForProcessing , ProcessingInProgress и ProcessingComplete . Возвращается только с помощью оператора $select . Только для чтения. |
String | SMTP-адрес для группы, например "[email protected]". Возвращается по умолчанию. Только для чтения. Поддерживает $filter (eq , ne , not , ge , le , in , startsWith и eq для значений null ). |
|
mailEnabled | Boolean | Указывает, включена ли для этой группы поддержка почты. Обязательный. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not и eq по null значениям). |
mailNickname | String | Почтовый псевдоним для группы, уникальный для групп Microsoft 365 в организации. Максимальная длина: 64 символа. Это свойство может содержать только символы из набора символов ASCII от 0 до 127, за исключением следующих: @ () \ [] " ; : <> , SPACE . Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , in , startsWith ). |
membershipRule | String | Правило, определяющее участников этой группы, если группа является динамической (groupTypes содержит DynamicMembership ). Дополнительные сведения о синтаксисе правила участия см. в здесь. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , startsWith ). |
membershipRuleProcessingState | String | Указывает, включена или приостановлена динамическая обработка участия. Возможные значения: On или Paused . Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , in ). |
membershipRuleProcessingStatus | membershipRuleProcessingStatus | Описывает состояние обработки для динамических групп на основе правил. Свойство предназначено null для динамических групп, не основанных на правилах, или если обработка динамических групп приостановлена. Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). Только для чтения. |
onPremisesDomainName | String | Содержит локальный параметр domain FQDN, также называемый dnsDomainName, синхронизированный из локального каталога. Свойство заполняется только для клиентов, синхронизирующих локальный каталог с Microsoft Entra ID через Microsoft Entra Connect. Возвращается по умолчанию. Только для чтения. |
onPremisesLastSyncDateTime | DateTimeOffset | Указывает время последней синхронизации группы с локальным каталогом. Тип Timestamp представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z . Возвращается по умолчанию. Только для чтения. Поддерживает $filter (eq , ne , not , ge , le , in ). |
onPremisesNetBiosName | String | Содержит локальный параметр netBios name, синхронизированный из локального каталога. Свойство заполняется только для клиентов, синхронизирующих локальный каталог с Microsoft Entra ID через Microsoft Entra Connect. Возвращается по умолчанию. Только для чтения. |
onPremisesProvisioningErrors | Коллекция onPremisesProvisioningError | Ошибки при использовании продукта синхронизации Майкрософт во время подготовки. Возвращается по умолчанию. Поддерживает $filter (eq , not ). |
onPremisesSamAccountName | String | Содержит локальный параметр SAM account name, синхронизированный из локального каталога. Свойство заполняется только для клиентов, синхронизирующих локальный каталог с Microsoft Entra ID через Microsoft Entra Connect. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , in , startsWith ). Только для чтения. |
onPremisesSecurityIdentifier | String | Содержит локальный идентификатор безопасности (SID) для группы, синхронизированной из локальной среды в облако. Только для чтения. Возвращается по умолчанию. Поддерживает $filter (eq в том числе null значений). |
onPremisesSyncEnabled | Boolean | Значение true указывает, что эта группа синхронизируется из локального каталога. Значение false указывает, что эта группа ранее синхронизировалась из локального каталога, но синхронизация больше не выполняется. Значение null указывает, что этот объект никогда не синхронизировался из локального каталога (значение по умолчанию). Возвращается по умолчанию. Только для чтения. Поддерживает $filter (eq , ne , not , in и eq для значений null ). |
preferredDataLocation | String | Предпочтительное расположение данных для группы Microsoft 365. По умолчанию группа наследует предпочтительное расположение данных создателя группы. Чтобы задать это свойство, вызывающему приложению должно быть предоставлено разрешение Directory.ReadWrite.All, а пользователю назначена по крайней мере одна из следующих Microsoft Entra ролей:
Дополнительные сведения об этом свойстве см. в разделах OneDrive Online Multi-Geo и Создание группы Microsoft 365 с определенным PDL. Допускается значение null. Возвращается по умолчанию. |
preferredLanguage | String | Предпочитаемый язык для группы Microsoft 365. Он должен быть представлен в формате ISO 639-1, например en-US . Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , in , startsWith и eq для значений null ). |
proxyAddresses | Коллекция String | Адреса электронной почты для группы, ведущие в один почтовый ящик группы. Пример: ["SMTP: [email protected]", "smtp: [email protected]"] . Для выражений фильтра в случае многозначных свойств требуется оператор any. Возвращается по умолчанию. Только для чтения. Значение null не допускается. Поддерживает $filter (eq , not , ge , le , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
renewedDateTime | DateTimeOffset | Метка времени последнего обновления группы. Не может изменяться непосредственно. Обновляется только при выполнении действия обновления. Тип Timestamp представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z . Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , ge , le , in ). Только для чтения. |
resourceBehaviorOptions | Коллекция объектов string | Определяет поведение группы, которое может быть задано для группы Microsoft 365 во время ее создания. Это свойство можно задать только при создании (POST). Список возможных значений см. в статье Поведение групп Microsoft 365 и параметры подготовки. |
resourceProvisioningOptions | Коллекция объектов string | Указывает ресурсы группы, связанные с группой Microsoft 365. Возможное значение — Team . Дополнительные сведения см. в статье Поведение групп Microsoft 365 и параметры подготовки. Возвращается по умолчанию. Поддерживает $filter (eq , not , startsWith . |
securityEnabled | Логический | Указывает, является ли эта группа группой безопасности. Обязательный. Возвращается по умолчанию. Поддерживает $filter (eq , ne , not , in ). |
securityIdentifier | String | Идентификатор безопасности группы, используемый в сценариях Windows. Только для чтения. Возвращается по умолчанию. |
serviceProvisioningErrors | serviceProvisioningError collection | Ошибки, опубликованные федеративной службой, описывающие не временную ошибку службы в отношении свойств или ссылки из объекта группы. |
theme | String | Указывает цветовую тему группы Microsoft 365. Возможные значения: Teal , Purple , Green , Blue , Pink , Orange или Red . Возвращается по умолчанию. |
uniqueName | Строка | Уникальный идентификатор, который можно назначить группе и использовать в качестве альтернативного ключа. Неизменяемый. Только для чтения. |
unseenConversationsCount | Int32 | Количество бесед, доставленных одной или несколькими новыми записями с момента последнего посещения группы пользователем, выполнившего вход. Это свойство совпадает с unseenCount. Возвращается только с помощью оператора $select . |
unseenCount | Int32 | Количество бесед с новыми сообщениями, полученными с момента последнего посещения группы вошедшим в систему пользователем. Это свойство совпадает с unseenConversationsCount. Возвращается только с помощью оператора $select . Поддерживается только для API получения группы (GET /groups/{ID} ). |
unseenMessagesCount | Int32 | Количество новых сообщений, опубликованных в беседах группы с момента последнего посещения группы вошедшим в систему пользователем. Возвращается только с помощью оператора $select . |
visibility | String | Указывает политику присоединения к группе и видимость содержимого для групп. Возможные значения: Private , Public или HiddenMembership .
HiddenMembership Можно задать только для групп Microsoft 365 при их создании. Обновление невозможно выполнить позже. Другие значения видимости можно обновлять после создания группы.Если значение видимости не указано во время создания группы в Microsoft Graph, по умолчанию создается Private группа безопасности, а группа Microsoft 365 — Public . Группы, которые можно назначить ролям, всегда являются Private . Дополнительные сведения см. в разделе Параметры видимости группы. Возвращается по умолчанию. Допускается значение null. |
writebackConfiguration | groupWritebackConfiguration | Указывает, настроена ли группа для обратной записи свойств объекта группы в локальная служба Active Directory. Эти свойства используются при настройке обратной записи групп в клиенте синхронизации Microsoft Entra Connect. |
Параметры видимости группы
Значение | Описание |
---|---|
Public | Любой пользователь может присоединиться к группе без разрешения владельца. Любой пользователь может просмотреть содержимое группы. |
Private | Чтобы присоединиться к группе, требуется разрешение владельца. Пользователи, не являющиеся участниками группы, не могут просматривать ее содержимое. |
HiddenMembership | Чтобы присоединиться к группе, требуется разрешение владельца. Пользователи, не являющиеся участниками группы, не могут просматривать ее содержимое. Пользователи, не являющиеся участниками группы, не могут просматривать ее участников. Администраторы (глобальные, организации, пользователей и службы поддержки) могут просматривать список участников группы. Группа отображается в глобальной адресной книге (глобальном списке адресов). |
Связи
Связь | Тип | Описание |
---|---|---|
acceptedSenders | Коллекция directoryObject | Список пользователей или групп, которым разрешено создавать записи или события календаря в этой группе. Если этот список не пуст, публикацию могут публиковать только пользователи или группы, перечисленные здесь. |
appRoleAssignments | Коллекция appRoleAssignment | Представляет роли группе, предоставленные пользователю для приложения. Поддерживает $expand . |
calendar | calendar | Календарь группы. Только для чтения. |
calendarView | Коллекция event | Представление календаря. Только для чтения. |
conversations | Коллекция conversation | Беседы группы. |
createdOnBehalfOf | directoryObject | Пользователь (или приложение) – создатель группы. Заметка: Этот параметр не устанавливается, если пользователь является администратором. Только для чтения. |
drive | drive | Используемый по умолчанию диск группы. Только для чтения. |
drives | Коллекция drive | Диск группы. Только для чтения. |
endpoints | Коллекция Endpoint | Конечные точки для группы. Только для чтения. Допускается значение null. |
events | Коллекция event | События группы. |
extensions | Коллекция extension | Коллекция открытых расширений, определенная для группы. Только для чтения. Допускается значение null. |
groupLifecyclePolicies | Коллекция groupLifecyclePolicy | Коллекция политик жизненного цикла для этой группы. Только для чтения. Допускается значение null. |
memberOf | Коллекция directoryObject | Группы и административные единицы, в которых состоит группа. Методы HTTP: GET (поддерживается для всех групп). Только для чтения. Допускается значение null. Поддерживает $expand . |
members | Коллекция directoryObject | Непосредственные участники группы, которые могут быть пользователями, устройствами, другими группами или субъектами-службами. Поддерживает операции Перечисление участников, Добавление участника и Удаление участника. Допускается значение null. Поддерживает $expand , включая вложенные $select . Например, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName) . |
membersWithLicenseErrors | Коллекция объектов user | Список участников группы с ошибками лицензий после группового назначения лицензий. Только для чтения. |
onenote | onenote | Только для чтения. |
owners | Коллекция directoryObject | Владельцы группы, которые могут быть пользователями или субъектами-службами. Максимальное количество владельцев: 100. Допускается значение null. Поддерживает $filter (/$count eq 0 , /$count ne 0 , /$count eq 1 , /$count ne 1 ); Поддерживает $expand , включая вложенные $select . Например, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName) . |
permissionGrants | resourceSpecificPermissionGrant | Разрешения, предоставленные группе определенному приложению. Поддерживает $expand . |
photo | profilePhoto | Фотография профиля группы. |
photos | Коллекция объектов profilePhoto | Фотографии профиля, принадлежащие группе. Только для чтения. Допускается значение null. |
planner | plannerGroup | Выборочные службы Планировщика, доступные для группы. Только для чтения. Допускается значение null. |
rejectedSenders | Коллекция directoryObject | Список пользователей или групп, которым запрещено создавать записи или события календаря в этой группе. Допускается значение null |
settings | Коллекция directorySetting | Параметры, управляющие поведением группы, например, могут ли участники приглашать гостевых пользователей в группу. Допускается значение null. |
sites | Коллекция объектов site | Список сайтов SharePoint в этой группе. Доступ к сайту по умолчанию с помощью /sites/root. |
team | Коллекция channel | Команда, связанная с этой группой. |
threads | Коллекция conversationThread | Цепочки бесед группы. Допускается значение null. |
transitiveMemberOf | Коллекция directoryObject | Группы, в которые входит группа, напрямую или через вложенное членство. Допускается значение null. |
transitiveMembers | Коллекция directoryObject | Непосредственные и транзитивные участники группы. Допускается значение null. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"accessType": "String",
"assignedLabels": [{ "@odata.type": "microsoft.graph.assignedLabel" }],
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"allowExternalSenders": false,
"autoSubscribeNewMembers": true,
"createdByAppId": "String",
"createdDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"expirationDateTime": "String (timestamp)",
"groupTypes": ["String"],
"hideFromAddressLists": false,
"hideFromOutlookClients": false,
"id": "String (identifier)",
"isFavorite": true,
"isArchived": false,
"isAssignableToRole": false,
"isSubscribedByMail": true,
"licenseProcessingState": "String",
"mail": "String",
"mailEnabled": true,
"mailNickname": "String",
"onPremisesDomainName": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesNetBiosName": "String",
"onPremisesProvisioningErrors": [
{ "@odata.type": "microsoft.graph.onPremisesProvisioningError" }
],
"onPremisesSamAccountName": "String",
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": true,
"preferredDataLocation": "String",
"proxyAddresses": ["String"],
"renewedDateTime": "String (timestamp)",
"resourceBehaviorOptions": ["String"],
"resourceProvisioningOptions": ["String"],
"securityEnabled": true,
"securityIdentifier": "String",
"serviceProvisioningErrors": [
{ "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
],
"uniqueName": "String",
"unseenConversationsCount": 1024,
"unseenCount": 1024,
"unseenMessagesCount": 1024,
"visibility": "String",
"acceptedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"calendarView": [{ "@odata.type": "microsoft.graph.event" }],
"conversations": [{ "@odata.type": "microsoft.graph.conversation" }],
"createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },
"drive": { "@odata.type": "microsoft.graph.drive" },
"events": [{ "@odata.type": "microsoft.graph.event" }],
"memberOf": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"members": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"membersWithLicenseErrors": [{ "@odata.type": "microsoft.graph.user" }],
"owners": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"photo": { "@odata.type": "microsoft.graph.profilePhoto" },
"photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
"rejectedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"sites": [{ "@odata.type": "microsoft.graph.site" }],
"threads": [{ "@odata.type": "microsoft.graph.conversationThread" }],
"classification": "String",
"hasMembersWithLicenseErrors": true,
"membershipRule": "String",
"membershipRuleProcessingState": "String",
"membershipRuleProcessingStatus": {
"@odata.type": "microsoft.graph.membershipRuleProcessingStatus"
},
"preferredLanguage": "String",
"theme": "String"
}