Listar assinaturas
Namespace: microsoft.graph
Recupere as propriedades e os relacionamentos das assinaturas do webhook, com base no ID do aplicativo, no usuário e na função do usuário com um locatário.
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 nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Esta API suporta os seguintes escopos de permissão; para saber mais, incluindo como escolher permissões, confira Permissões.
Recurso com suporte | Delegada (conta corporativa ou de estudante) | Delegada (conta pessoal da Microsoft) | Application |
---|---|---|---|
callRecord (/communications/callRecords) | Incompatível | Incompatível | CallRecords.Read.All |
callRecording communications/onlineMeetings/getAllRecordings Todas as gravações em uma organização. |
Sem suporte. | Sem suporte. | OnlineMeetingRecording.Read.All |
callRecording communications/onlineMeetings/{onlineMeetingId}/recordings Todas as gravações 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 fica disponível em uma reunião organizada por um usuário específico. |
OnlineMeetingRecording.Read.All | Sem suporte. | OnlineMeetingRecording.Read.All |
callTranscript communications/onlineMeetings/getAllTranscripts Todas as transcrições em uma organização. |
Sem suporte. | Sem suporte. | OnlineMeetingTranscript.Read.All |
callTranscript communications/onlineMeetings/{onlineMeetingId}/transcripts Todas as transcrições de 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 |
canal (/teams/getAllChannels – todos os canais em uma organização) | Incompatível | Sem suporte | Channel.ReadBasic.All, ChannelSettings.Read.All |
canal (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All | Sem suporte | Channel.ReadBasic.All, ChannelSettings.Read.All |
chat chat (/conversa – todos os chats em uma organização) | Incompatível | Incompatível | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |
chat (/chats/{id}) | Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All | Sem suporte | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All |
chat /appCatalogs/teamsApps/{id}/installedToChats Todos os chats em uma organização em que um aplicativo específico do Teams está instalado. |
Sem suporte | Sem suporte | 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 | 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) | Chat.Read, Chat.ReadWrite, Subscription.Read.All | Sem suporte | Chat.Read.All |
chatMessage (/teams/getAllMessages -- todas as mensagens de chat na organização) | Sem suporte | Sem suporte | Chat.Read.All |
chatMessage (/users/{id}/chats/getAllMessages -- mensagens de chat para todos os chats dos quais um usuário específico faz parte) | Chat.Read, Chat.ReadWrite | 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 em que um aplicativo específico 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 (/teams/{id}/channels/getAllMembers) | Incompatível | Incompatível | ChannelMember.Read.All |
conversationMember (/chats/getAllMembers) | Incompatível | Sem suporte | 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 | Incompatível | 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 em que um aplicativo específico 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/{id}/members) | TeamMember.Read.All, Subscription.Read.All | Incompatível | TeamMember.Read.All |
driveItem (OneDrive pessoal de um usuário) | Sem suporte | Files.ReadWrite, Subscription.Read.All | Sem suporte |
driveItem (OneDrive for Business) | 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 |
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 |
presence | Presence.Read.All, Subscription.Read.All | Sem suporte | Incompatível |
printer | 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 |
equipe (/teams – todas as equipes em uma organização) | Sem suporte | Incompatível | Team.ReadBasic.All, TeamSettings.Read.All |
equipe (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All | Incompatível | Team.ReadBasic.All, TeamSettings.Read.All |
todoTask | Tasks.ReadWrite, Subscription.Read.All | Tasks.ReadWrite, Subscription.Read.All | Incompatível |
user | User.Read.All, Subscription.Read.All | User.Read.All | User.Read.All |
Observação: Permissões marcadas com * usam consentimento específico de recurso.
Os resultados da resposta são baseados no contexto do aplicativo de chamada. As seções a seguir descrevem os cenários comuns.
Cenários Básicos
Comumente, um aplicativo deseja recuperar assinaturas originalmente criadas para o usuário atualmente conectado ou para todos os usuários no diretório (contas corporativas/de estudante). Esses cenários não exigem permissões especiais além das 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. Nota: Isso se aplica a contas pessoais da Microsoft e contas de trabalho/escola. |
Assinaturas criadas por este aplicativo apenas 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: Isso se aplica somente a contas de trabalho/escola. |
Assinaturas criadas por este aplicativo para si 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 pode querer 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 Nota: Isso se aplica a contas pessoais da Microsoft e contas de trabalho/escola. |
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. -e- O aplicativo tem a permissão Subscription.Read.All Nota: Isso se aplica apenas a contas de trabalho/escola. |
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. |
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/v1.0/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/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"
}
]
}
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.
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de