Listar assinaturas

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Recupere uma lista de assinaturas de webhook.

O conteúdo da resposta depende do contexto no qual o aplicativo está chamando; para obter detalhes, consulte os cenários na seção Permissões.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Dependendo do recurso e do tipo de permissão (delegado ou aplicativo) solicitado, a permissão especificada na tabela a seguir é a menos privilegiada necessária para fazer chamadas a esta API. Para saber mais, incluindo tomar cuidado antes de escolher as permissões mais privilegiadas, pesquise as seguintes permissões em Permissões.

Observação

Alguns recursos são compatíveis com notificações de alteração em vários cenários, cada um dos quais pode exigir permissões diferentes. Nesses casos, use o caminho do recurso para diferenciar os cenários.

Recurso com suporte Delegada (conta corporativa ou de estudante) Delegada (conta pessoal da Microsoft) Application
aiInsights
/copilot/users/{userId}/onlineMeetings/getAllAiInsights
Insights de IA do Copilot de reuniões das quais um determinado usuário faz parte.
OnlineMeetingAiInsight.Read.All Sem suporte. OnlineMeetingAiInsight.Read.All
aiInsights
/copilot/users/{userId}/onlineMeetings/{onlineMeetingId}/aiInsights
Insights de IA do Copilot para uma reunião específica.
OnlineMeetingAiInsight.Read.All Sem suporte. OnlineMeetingAiInsight.Read.All
aiInteraction
copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions
Interações de IA do Copilot das quais um determinado usuário faz parte.
AiEnterpriseInteraction.Read Sem suporte. AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User
aiInteraction
copilot/interactionHistory/getAllEnterpriseInteractions
Interações de IA do Copilot em uma organização.
Sem suporte. Sem suporte. AiEnterpriseInteraction.Read.All
approvalItems Sem suporte. Sem suporte. ApprovalSolution.ReadWrite.All
callRecord Sem suporte. Sem suporte. CallRecords.Read.All
callRecording
communications/onlineMeetings/getAllRecordings
Qualquer gravação fica disponível no locatário.
Sem suporte. Sem suporte. OnlineMeetingRecording.Read.All
callRecording
communications/onlineMeetings/{onlineMeetingId}/recordings
Qualquer gravação fica disponível para uma reunião específica.
OnlineMeetingRecording.Read.All Sem suporte. OnlineMeetingRecording.Read.All
callRecording
users/{userId}/onlineMeetings/getAllRecordings
Uma gravação de chamada que se torna disponível em uma reunião organizada por um usuário específico.
OnlineMeetingRecording.Read.All Sem suporte. OnlineMeetingRecording.Read.All
callRecording
appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings
Uma gravação de chamada que se torna disponível em uma reunião em que um determinado aplicativo do Teams está instalado.
Sem suporte. Sem suporte. OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read. Chat
callTranscript
communications/onlineMeetings/getAllTranscripts
Qualquer transcrição fica disponível no locatário.
Sem suporte. Sem suporte. OnlineMeetingTranscript.Read.All
callTranscript
communications/onlineMeetings/{onlineMeetingId}/transcripts
Qualquer transcrição fica disponível para uma reunião específica.
OnlineMeetingTranscript.Read.All Sem suporte. OnlineMeetingTranscript.Read.All
callTranscript
users/{userId}/onlineMeetings/getAllTranscripts
Uma transcrição de chamada que fica disponível em uma reunião organizada por um usuário específico.
OnlineMeetingTranscript.Read.All Sem suporte. OnlineMeetingTranscript.Read.All
callTranscript
appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts
Uma transcrição de chamada que se torna disponível em uma reunião em que um determinado aplicativo do Teams está instalado.
Sem suporte. Sem suporte. OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read. Chat
canal
/teams/getAllChannels
Todos os canais em uma organização.
Sem suporte. Sem suporte. Channel.ReadBasic.All, ChannelSettings.Read.All
canal
/teams/{id}/channels
Todos os canais em uma equipe específica em uma organização.
Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All Sem suporte. Channel.ReadBasic.All, ChannelSettings.Read.All
chat
/chats
Todos os chats em uma organização.
Sem suporte. Sem suporte. Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat
/chats/{id}
Um chat específico.
Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All Sem suporte. ChatSettings.Read. Chat, ChatSettings.ReadWrite. Chat, Chat. Gerar. Chat, Chat. ReadBasic.All, Chat. Read.All, Chat. ReadWrite.All
chat
/appCatalogs/teamsApps/{id}/installedToChats
Todos os chats em uma organização onde um determinado aplicativo do Teams está instalado.
Sem suporte. Sem suporte. Chat. ReadBasic.WhereInstalled, Chat. Read.WhereInstalled, Chat. ReadWrite.WhereInstalled
chat
/users/{id}/chats
Todos os chats dos quais um determinado usuário faz parte.
Chat.ReadBasic, Chat.Read, Chat.ReadWrite Sem suporte. Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chatMessage
/teams/{id}/channels/{id}/messages
Todas as mensagens e respostas em um canal específico.
ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All Sem suporte. ChannelMessage.Read.Group, ChannelMessage.Read.All
chatMessage
/teams/getAllMessages
Todas as mensagens de canal na organização.
Sem suporte. Sem suporte. ChannelMessage.Read.All
chatMessage
/chats/{id}/messages
Todas as mensagens em um chat.
Chat.Read, Chat.ReadWrite, Subscription.Read.All Sem suporte. Chat.Read.All
chatMessage
/chats/getAllMessages
Todas as mensagens de chat em uma organização.
Sem suporte. Sem suporte. Chat.Read.All
chatMessage
/users/{id}/chats/getAllMessages
Mensagens de Chat para todos os chats dos quais um determinado usuário faz parte.
Chat.Read, Chat.ReadWrite, Subscription.Read.All Sem suporte. Chat.Read.All, Chat.ReadWrite.All
chatMessage
/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages
Mensagens de Chat para todos os chats em uma organização onde um determinado aplicativo do Teams está instalado.
Sem suporte. Sem suporte. Chat. Read.WhereInstalled, Chat. ReadWrite.WhereInstalled
contato Contacts.Read, Subscription.Read.All Contacts.Read, Subscription.Read.All Contacts.Read
conversationMember
/chats/getAllMembers
Membros de todos os chats em uma organização.
Sem suporte. Sem suporte. ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember
/chats/{id}/members
Membros de um chat específico.
ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All Sem suporte. 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
Membros do Chat para todos os chats em uma organização onde um determinado aplicativo do Teams está instalado.
Sem suporte. Sem suporte. ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat. ReadBasic.WhereInstalled, Chat. Read.WhereInstalled, Chat. ReadWrite.WhereInstalled
conversationMember
/teams/getAllMembers
Membros em todas as equipes de uma organização.
Sem suporte. Sem suporte. TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember
/teams/{id}/members
Membros de uma equipe específica.
TeamMember.Read.All, Subscription.Read.All Sem suporte. TeamMember.Read.All
conversationMember
/teams/{id}/channels/getAllMembers
Membros em todos os canais privados de uma equipe específica.
Sem suporte. Sem suporte. ChannelMember.Read.All
conversationMember
/teams/getAllChannels/getAllMembers
Sem suporte. Sem suporte. ChannelMember.Read.All
driveItem
OneDrive pessoal do usuário.
Sem suporte. Files.ReadWrite, Subscription.Read.All Sem suporte.
driveItem
OneDrive corporativo ou de estudante.
Files.ReadWrite.All, Subscription.Read.All Sem suporte. Files.ReadWrite.All
evento Calendars.Read, Subscription.Read.All Calendars.Read, Subscription.Read.All Calendars.Read
grupo Group.Read.All, Subscription.Read.All Sem suporte. Group.Read.All
conversa em grupo Group.Read.All, Subscription.Read.All Sem suporte. Sem suporte.
Alerta de monitoramento do Microsoft Entra Health
/reports/healthmonitoring/alerts
HealthMonitoringAlertConfig.Read.All Sem suporte. HealthMonitoringAlertConfig.Read.All
list Sites.ReadWrite.All, Subscription.Read.All Sem suporte. 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
Alterações em qualquer solicitação de turno de oferta em uma equipe.
Schedule.Read.All, Schedule.ReadWrite.All Sem suporte. Schedule.Read.All, Schedule.ReadWrite.All
reunião online Sem suporte. Sem suporte. OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All
openShiftChangeRequest
/teams/{id}/schedule/openShiftChangeRequests
Alterações em qualquer solicitação de turno aberto em uma equipe.
Schedule.Read.All, Schedule.ReadWrite.All Sem suporte. Schedule.Read.All, Schedule.ReadWrite.All
presence Presence.Read.All, Subscription.Read.All Sem suporte. Sem suporte.
impressora Sem suporte. Sem suporte. Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition Sem suporte. Sem suporte. PrintTaskDefinition.ReadWrite.All
alerta de segurança SecurityEvents.ReadWrite.All, Subscription.Read.All Sem suporte. SecurityEvents.ReadWrite.All
shift
/teams/{id}/schedule/shifts
Mudanças em qualquer turno em uma equipe.
Schedule.Read.All, Schedule.ReadWrite.All Sem suporte. Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest
/teams/{id}/schedule/swapShiftsChangeRequests
Alterações em qualquer solicitação de turno de troca em uma equipe.
Schedule.Read.All, Schedule.ReadWrite.All Sem suporte. Schedule.Read.All, Schedule.ReadWrite.All
team
/teams
Todas as equipes em uma organização.
Sem suporte. Sem suporte. Team.ReadBasic.All, TeamSettings.Read.All
team
/teams/{id}
Uma equipe específica.
Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All Sem suporte. Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest
/teams/{id}/schedule/timeOffRequests
Alterações em qualquer solicitação de folga em uma equipe.
Schedule.Read.All, Schedule.ReadWrite.All Sem suporte. Schedule.Read.All, Schedule.ReadWrite.All
todoTask Tasks.ReadWrite, Subscription.Read.All Tasks.ReadWrite, Subscription.Read.All Sem suporte.
user User.Read.All, Subscription.Read.All User.Read.All User.Read.All
baseTask (preterido) Tasks.ReadWrite, Subscription.Read.All Tasks.ReadWrite, Subscription.Read.All Sem suporte.

Observação

As seguintes permissões usam o consentimento específico do recurso:

  • OnlineMeetingRecording.Read. Chat
  • OnlineMeetingTranscript.Read. Chat
  • ChatSettings.Read.Chat
  • ChatSettings.ReadWrite.Chat
  • Chat.Manage.Chat
  • ChannelMessage.Read.Group
  • ChatMember.Read.Chat
  • AiEnterpriseInteraction.Read.User

Os resultados da resposta são baseados no contexto do aplicativo de chamada. As seções a seguir descrevem os cenários comuns.

aiInsights

As assinaturas no Copilot AI Insights exigem uma licença válida do Copilot que inclua o seguinte plano de serviço do Copilot:

  • Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

aiInteraction

As assinaturas nas interações de IA do Copilot exigem uma licença válida do Copilot que inclua o seguinte plano de serviço do Copilot:

  • Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

Para assinaturas direcionadas a interações de IA do Copilot das quais um determinado usuário faz parte, o usuário no caminho do recurso deve ter os planos de serviço anteriores atribuídos a ele em um estado válido.

Para assinaturas que direcionam interações de IA do Copilot para todo o locatário, o locatário deve ter licenças válidas provisionadas que incluam todos os planos de serviço anteriores do Copilot.

Cenários Básicos

Normalmente, um aplicativo deseja recuperar assinaturas criadas originalmente para o usuário conectado no momento ou para todos os usuários no diretório (contas corporativas/de estudante). Esses cenários não exigem nenhuma permissão especial além daquelas que o aplicativo usou originalmente para criar suas assinaturas.

Contexto do aplicativo de chamada A resposta contém
O aplicativo está chamando em nome do usuário conectado (permissão delegada).
-e-
O aplicativo tem a permissão original necessária para criar a assinatura.

Observação: Esse cenário se aplica tanto a contas pessoais da Microsoft quanto a contas corporativas/de estudante.
Assinaturas criadas pelo aplicativo somente para o usuário conectado.
O aplicativo está chamando em nome de si mesmo (permissão de aplicativo).
-e-
O aplicativo tem a permissão original necessária para criar a assinatura.

Observação: este cenário só se aplica a contas corporativas/de estudante.
Assinaturas criadas pelo aplicativo para si próprio ou para qualquer usuário no diretório.

Cenários avançados

Em alguns casos, um aplicativo deseja recuperar assinaturas criadas por outros aplicativos. Por exemplo, um usuário deseja ver todas as assinaturas criadas por qualquer aplicativo em seu nome. Ou, um Administrador Global que deseja ver todas as assinaturas de todos os aplicativos em seu diretório. Para esses cenários, é necessária uma permissão delegada Subscription.Read.All.

Contexto do aplicativo de chamada A resposta contém
O aplicativo está chamando em nome do usuário conectado (permissão delegada). O usuário é um não administrador.
-e-
O aplicativo tem a permissão Subscription.Read.All

Observação: esse cenário se aplica tanto a contas pessoais da Microsoft quanto a contas corporativas/de estudante.
Assinaturas criadas por qualquer aplicativo apenas para o usuário conectado.
O aplicativo está chamando em nome do usuário conectado (permissão delegada). O usuário é um Administrador Global.
-e-
O aplicativo tem a permissão Subscription.Read.All

Observação: este cenário só se aplica a contas corporativas/de estudante.
Assinaturas criadas por qualquer aplicativo para qualquer usuário no diretório.

Solicitação HTTP

GET /subscriptions

Parâmetros de consulta opcionais

Esse método não dá suporte aos parâmetros de consulta OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome Tipo Descrição
Autorização string {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se bem sucedido, este método retorna um código de resposta 200 OK e uma lista de objetos de assinatura no corpo da resposta.

Exemplo

Solicitação

GET https://graph.microsoft.com/beta/subscriptions

Resposta

O exemplo a seguir mostra a resposta.

Observação: a resposta mostrada aqui pode ser reduzida para legibilidade.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$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"
    }
  ]
}

Observação: o valor da propriedade clientState não é retornado para fins de segurança.

Quando uma solicitação retorna várias páginas de dados, a resposta inclui uma propriedade @odata.nextLink para ajudá-lo a gerenciar os resultados. Para saber mais, consulte Paginação de dados do Microsoft Graph em seu aplicativo.