Вывод группы
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение свойств и связей объекта group.
Это действие по умолчанию возвращает только часть всех доступных свойств, как указано в разделе Свойства. Чтобы получить свойства, которые t_ возвращены по умолчанию, укажите их в параметре $select
запроса OData. Свойства hasMembersWithLicenseErrors и isArchived являются исключением и не возвращаются в запросе $select
. Так как ресурс group поддерживает расширения, с помощью операции GET
вы можете также получить настраиваемые свойства и данные расширения в экземпляре group.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
HTTP-запрос
GET /groups/{id}
Необязательные параметры запросов
Вы можете использовать $select
для получения определенных свойств группы, включая свойства, которые не возвращаются по умолчанию. Свойства расширения также поддерживают параметры запроса следующим образом:
Тип расширения | Комментарии |
---|---|
Расширения схемы | Возвращается только с помощью $select . |
Открытые расширения | Возврат через операцию Получение открытого расширения. |
Расширения каталога | Возвращается по умолчанию. |
Дополнительные сведения о параметрах запроса OData см. в статье Параметры запроса OData.
Заголовки запросов
Имя | Тип | Описание |
---|---|---|
Authorization | string | Bearer {token}. Обязательно. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успеха этот метод возвращает код отклика 200 OK
и объект group в тексте отклика. Он возвращает параметры по умолчанию, если не используется параметр $select
для указания конкретных свойств.
Пример
Пример 1. Возвращение всех свойств по умолчанию
Запрос
Ниже приведен пример запроса GET.
GET https://graph.microsoft.com/beta/groups/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4
Отклик
Ниже приведен пример отклика. Он включает только стандартные свойства.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости. В реальном вызове возвращаются все свойства по умолчанию.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups/$entity",
"@odata.id": "https://graph.microsoft.com/v2/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4/directoryObjects/4de51a22-3289-4ea5-bbdb-8503ea644f1b/Microsoft.DirectoryServices.Group",
"id": "4de51a22-3289-4ea5-bbdb-8503ea644f1b",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2021-09-13T10:07:01Z",
"createdByAppId": "de8bc8b5-d9f9-48b1-a8ad-b748da725064",
"organizationId": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
"description": "Self help community for library",
"displayName": "Library Assist",
"expirationDateTime": "2022-01-11T10:07:01Z",
"groupTypes": [
"Unified"
],
"infoCatalogs": [],
"isAssignableToRole": null,
"isManagementRestricted": null,
"mail": "library@contoso.com",
"mailEnabled": true,
"mailNickname": "library",
"membershipRule": null,
"membershipRuleProcessingState": null,
"onPremisesDomainName": null,
"onPremisesLastSyncDateTime": null,
"onPremisesNetBiosName": null,
"onPremisesSamAccountName": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": "EU",
"preferredLanguage": null,
"proxyAddresses": [
"SPO:SPO_0dbffe23-f6fb-4478-adcd-880daf88bb12@SPO_45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
"SMTP:library@contoso.com"
],
"renewedDateTime": "2021-09-13T10:07:01Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [],
"securityEnabled": false,
"securityIdentifier": "S-1-12-1-1306860066-1319449225-59104187-458188010",
"serviceProvisioningErrors": [],
"theme": null,
"visibility": "Public",
"writebackConfiguration": {
"isEnabled": null,
"onPremisesGroupType": null
},
"onPremisesProvisioningErrors": []
}
Пример 2. Возврат свойств с помощью $select
Запрос
Ниже приведен пример запроса GET.
GET https://graph.microsoft.com/beta/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount
Отклик
Ниже приведен пример ответа, включающего запрошенные свойства nondefault.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
"id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
"allowExternalSenders": false,
"autoSubscribeNewMembers": false,
"isSubscribedByMail": false,
"unseenCount": 0
}
Пример 3. Чтение определенной динамической группы
Запрос
Ниже приведен пример запроса.
GET https://graph.microsoft.com/beta/groups/1cdf9c18-a7dc-46b1-b47f-094d5656376d?$select=id,membershipRule,membershipRuleProcessingState,membershipRuleProcessingStatus
Отклик
Ниже приведен пример отклика.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(id,membershipRule,membershipRuleProcessingState,membershipRuleProcessingStatus)/$entity",
"id": "1cdf9c18-a7dc-46b1-b47f-094d5656376d",
"membershipRule": "accountEnabled eq true",
"membershipRuleProcessingState": "On",
"membershipRuleProcessingStatus": {
"status" : "NotStarted",
"lastMembershipUpdated" : null,
"errorMessage" : null
}
}
Пример 4. Проверка ограниченности управления группой
Запрос
GET https://graph.microsoft.com/beta/groups/aed0b780-965f-4149-85c5-a8c73e58brt6?$select=isManagementRestricted
Отклик
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"isManagementRestricted": true
}
Связанные материалы
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по