Поделиться через


Перечисление подписок

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

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

Содержимое ответа зависит от контекста, в котором вызывается приложение; подробные сведения см. в разделе Разрешения.

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

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

Разрешения

Этот API поддерживает перечисленные ниже области разрешений. Дополнительные сведения, в том числе о выборе разрешений, см. в статье Разрешения.

Поддерживаемый ресурс Делегированное (рабочая или учебная учетная запись) Делегированное (личная учетная запись Майкрософт) Application
callRecord (/communications/callRecords) Не поддерживается Не поддерживается CallRecords.Read.All
callRecording
communications/onlineMeetings/getAllRecordings
Все записи в организации.
Не поддерживается. Не поддерживается. OnlineMeetingRecording.Read.All
callRecording
communications/onlineMeetings/{onlineMeetingId}/recordings
Все записи для определенного собрания.
OnlineMeetingRecording.Read.All Не поддерживается. OnlineMeetingRecording.Read.All
callRecording
users/{userId}/onlineMeetings/getAllRecordings
Запись звонка, которая становится доступной на собрании, организованном определенным пользователем.
OnlineMeetingRecording.Read.All Не поддерживается. OnlineMeetingRecording.Read.All
callTranscript
communications/onlineMeetings/getAllTranscripts
Все расшифровки в организации.
Не поддерживается. Не поддерживается. OnlineMeetingTranscript.Read.All
callTranscript
communications/onlineMeetings/{onlineMeetingId}/transcripts
Все стенограммы для определенного собрания.
OnlineMeetingTranscript.Read.All Не поддерживается. OnlineMeetingTranscript.Read.All
callTranscript
users/{userId}/onlineMeetings/getAllTranscripts
Расшифровка звонка, которая становится доступной на собрании, организованном определенным пользователем.
OnlineMeetingTranscript.Read.All Не поддерживается. OnlineMeetingTranscript.Read.All
channel (/teams/getAllChannels — все каналы в организации) Не поддерживается Не поддерживается Channel.ReadBasic.All, ChannelSettings.Read.All
channel (/teams/{id}/channels) Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All Не поддерживается Channel.ReadBasic.All, ChannelSettings.Read.All
чат (/чаты — все чаты в организации) Не поддерживается Не поддерживается Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
чат (/chats/{id}) Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All Не поддерживается ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat
/appCatalogs/teamsApps/{id}/installedToChats
Все чаты в организации, где установлено определенное приложение Teams.
Не поддерживается Не поддерживается Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chatMessage (/teams/{id}/channels/{id}/messages) ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All Не поддерживается ChannelMessage.Read.Group*, ChannelMessage.Read.All
chatMessage (/teams/getAllMessages — все сообщения канала в организации) Не поддерживается Не поддерживается ChannelMessage.Read.All
chatMessage (/chats/{id}/messages) Chat.Read, Chat.ReadWrite, Subscription.Read.All Не поддерживается Chat.Read.All
chatMessage (/chats/getAllMessages — все сообщения чата в организации) Не поддерживается Не поддерживается Chat.Read.All
chatMessage (/users/{id}/chats/getAllMessages — сообщения чата для всех чатов, в которые входит определенный пользователь) Chat.Read, Chat.ReadWrite Не поддерживается Chat.Read.All, Chat.ReadWrite.All
chatMessage
/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages
Сообщения чата для всех чатов в организации, где установлено определенное приложение Teams.
Не поддерживается. Не поддерживается. Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact Contacts.Read, Subscription.Read.All Contacts.Read, Subscription.Read.All Contacts.Read
conversationMember (/teams/{id}/channels/getAllMembers) Не поддерживается Не поддерживается ChannelMember.Read.All
conversationMember (/chats/getAllMembers) Не поддерживается Не поддерживается ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember (/chats/{id}/members) ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All Не поддерживается ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember
/appCatalogs/teamsApps/{id}/installedToChats/getAllMembers
Участники чата для всех чатов в организации, в которой установлено определенное приложение Teams.
Не поддерживается Не поддерживается ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember (/teams/{id}/members) TeamMember.Read.All, Subscription.Read.All Не поддерживается TeamMember.Read.All
driveItem (личное хранилище OneDrive пользователя) Не поддерживается Files.ReadWrite, Subscription.Read.All Не поддерживается
driveItem (OneDrive для работы или учебы) Files.ReadWrite.All, Subscription.Read.All Не поддерживается Files.ReadWrite.All
event Calendars.Read, Subscription.Read.All Calendars.Read, Subscription.Read.All Calendars.Read
group Group.Read.All, Subscription.Read.All Не поддерживается Group.Read.All
group conversation Group.Read.All, Subscription.Read.All Не поддерживается Не поддерживается
list Sites.ReadWrite.All, Subscription.Read.All Не поддерживается Sites.ReadWrite.All
message Mail.ReadBasic, Mail.Read, Subscription.Read.All Mail.ReadBasic, Mail.Read, Subscription.Read.All Mail.Read
offerShiftRequest
(/teams/{id}/schedule/offerShiftRequests)
Изменения в любом запросе на смену предложения в команде.
Schedule.Read.All, Schedule.ReadWrite.All Не поддерживается. Schedule.Read.All, Schedule.ReadWrite.All
openShiftChangeRequest
(/teams/{id}/schedule/openShiftChangeRequests)
Изменения в любом запросе на открытые смены в команде.
Schedule.Read.All, Schedule.ReadWrite.All Не поддерживается. Schedule.Read.All, Schedule.ReadWrite.All
presence Presence.Read.All, Subscription.Read.All Не поддерживается Не поддерживается
printer Не поддерживается Не поддерживается Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition Не поддерживается Не поддерживается PrintTaskDefinition.ReadWrite.All
security alert SecurityEvents.ReadWrite.All, Subscription.Read.All Не поддерживается SecurityEvents.ReadWrite.All
shift
(/teams/{id}/schedule/shifts)
Изменения в любой смене в команде.
Schedule.Read.All, Schedule.ReadWrite.All Не поддерживается. Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest
(/teams/{id}/schedule/swapShiftsChangeRequests)
Изменения в любом запросе на смену переключения в команде.
Schedule.Read.All, Schedule.ReadWrite.All Не поддерживается. Schedule.Read.All, Schedule.ReadWrite.All
teams (/teams — все команды в организации) Не поддерживается Не поддерживается Team.ReadBasic.All, TeamSettings.Read.All
team (/teams/{id}) Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All Не поддерживается Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest
(/teams/{id}/schedule/timeOffRequests)
Изменения в любом запросе на отгул в команде.
Schedule.Read.All, Schedule.ReadWrite.All Не поддерживается. Schedule.Read.All, Schedule.ReadWrite.All
todoTask Tasks.ReadWrite, Subscription.Read.All Tasks.ReadWrite, Subscription.Read.All Не поддерживается
user User.Read.All, Subscription.Read.All User.Read.All User.Read.All

Примечание. Разрешения, помеченные звездочкой (*), используют согласие для конкретных ресурсов.

Результаты отклика основаны на контексте приложения, отправившего вызов. В следующих разделах описываются общие сценарии.

Основные сценарии

Чаще всего приложению нужно получить подписки, изначально созданные им для текущего пользователя или для всех пользователей в каталоге (рабочих или учебных учетных записей). В этих сценариях не требуются специальные разрешения, кроме тех, которые приложение использовало для создания подписок.

Контекст приложения, отправившего вызов Состав отклика
Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение).
-и-
У приложения есть исходное разрешение, необходимое для создания подписки.

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

Примечание: Это относится только к рабочим и учебным учетным записям.
Подписки, созданные этим приложением для себя или для любого пользователя в каталоге.

Расширенные сценарии

В некоторых случаях приложению нужно получить подписки, созданные другими приложениями. Например, пользователь хочет просмотреть все подписки, созданные каким-либо приложением от его имени. Кроме того, глобальный администратор может захотеть просмотреть все подписки из всех приложений в своем каталоге. В таких сценариях требуется делегированное разрешение Subscription.Read.All.

Контекст приложения, отправившего вызов Состав отклика
Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). Пользователь не является администратором.
-и-
У приложения есть разрешение Subscription.Read.All

Примечание. Это относится как к личным учетным записям Майкрософт, так и к рабочим и учебным учетным записям.
Подписки, созданные любым приложением только для вошедшего пользователя.
Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). Пользователь является глобальным администратором.
-и-
У приложения есть разрешение Subscription.Read.All

Примечание. Это относится только к рабочим или учебным учетным записям.
Подписки, созданные любым приложением для любого пользователя в каталоге.

HTTP-запрос

GET /subscriptions

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

Этот метод не поддерживает параметры запроса OData для настройки ответа.

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

Имя Тип Описание
Authorization string Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

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

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

Отклик

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

Пример

Запрос

GET https://graph.microsoft.com/v1.0/subscriptions

Отклик

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions",
  "value": [
    {
      "id": "0fc0d6db-0073-42e5-a186-853da75fb308",
      "resource": "Users",
      "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
      "changeType": "updated,deleted",
      "clientState": null,
      "notificationUrl": "https://webhookappexample.azurewebsites.net/api/notifications",
      "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
      "expirationDateTime": "2018-03-12T05:00:00Z",
      "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
      "latestSupportedTlsVersion": "v1_2",
      "encryptionCertificate": "",
      "encryptionCertificateId": "",
      "includeResourceData": false,
      "notificationContentType": "application/json"
    }
  ]
}

Примечание. Значение свойства clientState не возвращается в целях безопасности.

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