Liste des abonnements

Espace de noms: microsoft.graph

Récupérer les propriétés et les relations entre les abonnements webhook basés sur l’ID de l’application, l’utilisateur et le rôle de l’utilisateur avec un client.

Le contenu de la réponse dépend du contexte dans lequel l’application émet l’appel ; Pour plus d’informations, consultez les scénarios dans la section Autorisations.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Ressource prise en charge	Déléguée (compte professionnel ou scolaire)	Déléguée (compte Microsoft personnel)	Application
callRecord (/communications/callRecords)	Non pris en charge	Non pris en charge	CallRecords.Read.All
callRecording communications/onlineMeetings/getAllRecordings Tous les enregistrements d’une organisation.	Non prise en charge.	Non prise en charge.	OnlineMeetingRecording.Read.All
callRecording communications/onlineMeetings/{onlineMeetingId}/recordings Tous les enregistrements d’une réunion spécifique.	OnlineMeetingRecording.Read.All	Non prise en charge.	OnlineMeetingRecording.Read.All
callRecording users/{userId}/onlineMeetings/getAllRecordings Enregistrement d’appel qui devient disponible dans une réunion organisée par un utilisateur spécifique.	OnlineMeetingRecording.Read.All	Non prise en charge.	OnlineMeetingRecording.Read.All
callTranscript communications/onlineMeetings/getAllTranscripts Toutes les transcriptions d’une organisation.	Non prise en charge.	Non prise en charge.	OnlineMeetingTranscript.Read.All
callTranscript communications/onlineMeetings/{onlineMeetingId}/transcripts Toutes les transcriptions d’une réunion spécifique.	OnlineMeetingTranscript.Read.All	Non prise en charge.	OnlineMeetingTranscript.Read.All
callTranscript users/{userId}/onlineMeetings/getAllTranscripts Transcription d’appel qui devient disponible dans une réunion organisée par un utilisateur spécifique.	OnlineMeetingTranscript.Read.All	Non prise en charge.	OnlineMeetingTranscript.Read.All
canal (/teams/getAllChannels : tous les canaux d'une organisation)	Non pris en charge	Non pris en charge	Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All
canal (/teams/{id}/channels)	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	Non pris en charge	Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All
chat (/conversations : toutes les conversations d’une organisation)	Non pris en charge	Non pris en charge	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat (/chats/{id})	Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Non pris en charge	ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversation /appCatalogs/teamsApps/{id}/installedToChats Toutes les conversations dans une organisation où une application Teams particulière est installée.	Non pris en charge	Non pris en charge	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	Non pris en charge	ChannelMessage.Read.Group*, ChannelMessage.Read.All
chatMessage (/teams/getAllMessages--tous les messages de canal dans l’organisation)	Non pris en charge	Non pris en charge	ChannelMessage.Read.All
chatMessage (/chats/{ID}/messages)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Non pris en charge	Chat.Read.All
chatMessage (/teams/getAllMessages--tous les messages de canal dans l’organisation)	Non pris en charge	Non pris en charge	Chat.Read.All
chatMessage (/users/{id}/chats/getAllMessages : messages de conversation pour toutes les conversations dont fait partie un utilisateur particulier)	Chat.Read, Chat.ReadWrite	Non pris en charge	Chat.Read.All, Chat.ReadWrite.All
chatMessage /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages Messages de conversation pour toutes les conversations dans une organisation où une application Teams particulière est installée.	Non prise en charge.	Non prise en charge.	Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact	Contacts.Read, Subscription.Read.All	Contacts.Read, Subscription.Read.All	Contacts.Read
conversationMember (/teams/{id}/channels/getAllMembers)	Non pris en charge	Non pris en charge	ChannelMember.Read.All
conversationMember (/chats/getAllMembers)	Non pris en charge	Non pris en charge	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	Non pris en charge	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 Membres de conversation pour toutes les conversations dans une organisation où une application Teams particulière est installée.	Non pris en charge	Non pris en charge	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	Non pris en charge	TeamMember.Read.All
driveItem(OneDrive personnel de l’utilisateur)	Non pris en charge	Files.ReadWrite, Subscription.Read.All	Non pris en charge
driveItem (OneDrive professionnel ou scolaire)	Files.ReadWrite.All, Subscription.Read.All	Non pris en charge	Files.ReadWrite.All
event	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
groupe	Group.Read.All, Subscription.Read.All	Non pris en charge	Group.Read.All
Conversation de groupe	Group.Read.All, Subscription.Read.All	Non pris en charge	Non pris en charge
liste	Sites.ReadWrite.All, Subscription.Read.All	Non pris en charge	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) Modifications apportées à toute demande de shift d’offre dans une équipe.	Schedule.Read.All, Schedule.ReadWrite.All	Non prise en charge.	Schedule.Read.All, Schedule.ReadWrite.All
openShiftChangeRequest (/teams/{id}/schedule/openShiftChangeRequests) Modifications apportées à toute demande de shift ouverte dans une équipe.	Schedule.Read.All, Schedule.ReadWrite.All	Non prise en charge.	Schedule.Read.All, Schedule.ReadWrite.All
présence	Presence.Read.All, Subscription.Read.All	Non pris en charge	Non pris en charge
imprimante	Non pris en charge	Non pris en charge	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	Non pris en charge	Non pris en charge	PrintTaskDefinition.ReadWrite.All
alerte de sécurité	SecurityEvents.ReadWrite.All, Subscription.Read.All	Non pris en charge	SecurityEvents.ReadWrite.All
shift (/teams/{id}/schedule/shifts) Modifications apportées à n’importe quel changement dans une équipe.	Schedule.Read.All, Schedule.ReadWrite.All	Non prise en charge.	Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest (/teams/{id}/schedule/swapShiftsChangeRequests) Modifications apportées à toute demande de shift d’échange dans une équipe.	Schedule.Read.All, Schedule.ReadWrite.All	Non prise en charge.	Schedule.Read.All, Schedule.ReadWrite.All
teams (/teams : toutes les équipes d'une organisation)	Non pris en charge	Non pris en charge	Team.ReadBasic.All, TeamSettings.Read.All
équipe (/teams/{id})	Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All	Non pris en charge	Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest (/teams/{id}/schedule/timeOffRequests) Modifications apportées à toute demande de congé dans une équipe.	Schedule.Read.All, Schedule.ReadWrite.All	Non prise en charge.	Schedule.Read.All, Schedule.ReadWrite.All
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Non pris en charge
utilisateur	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All

Remarque : les autorisations marquées d’un astérisque (*) utilisent une autorisation propre aux ressources.

Les résultats de réponse sont basés sur le contexte de l’application de l’appel. Les sections suivantes décrivent les scénarios courants.

Scénario de base

Plus fréquemment, une application souhaite récupérer un abonnements qu’elle créée pour l’utilisateur actuellement connecté ou pour tous les utilisateurs dans l’annuaire (comptes professionnels ou scolaires). Ces scénarios ne nécessitent pas d’autorisations spéciales au-delà de celles utilisées à l’origine par l’application pour créer ses abonnements.

Contexte de l’application appelante	La réponse contient
L’application appelle à la place de l’utilisateur connecté(autorisation de délégué). et L’application dispose des autorisations d’origine nécessaires pour créer l’abonnement. Remarque : Cela s’applique aux comptes Microsoft personnels et comptes professionnel ou scolaires.	Abonnements créés parcette application pour l’utilisateur connecté uniquement.
L’application appelle en son nom propre (autorisation d’application). et L’application dispose des autorisations d’origine nécessaires pour créer l’abonnement. Remarque : Cela s’applique uniquement aux comptes scolaires/professionnels.	Abonnements créés par cette application pour elle-même ou pour tous les utilisateurs dans l’annuaire.

Scénarios d’enregistrement avancés

Dans certains cas, une application souhaite récupérer des abonnements créés par les autres applications. Par exemple, un utilisateur souhaite voir tous les abonnements créés par n’importe quelle application en leur nom. Ou bien, un administrateur général peut souhaiter voir tous les abonnements de toutes les applications dans son annuaire. Pour ces scénarios, une autorisation déléguée Subscription.Read.All est requise.

Contexte de l’application appelante	La réponse contient
L’application appelle à la place de l’utilisateur connecté(autorisation de délégué). L’utilisateur n’est pas un administrateur. et L’application a l’autorisation Subscription.Read.All Remarque : Cela s’applique aux comptes Microsoft personnels et comptes professionnel ou scolaires.	Abonnements créés parn’importe quelle application pour l’utilisateur connecté uniquement.
L’application appelle à la place de l’utilisateur connecté(autorisation de délégué). L’utilisateur est administrateur général. et L’application a l’autorisation Subscription.Read.All Remarque : Cela s’applique pour les comptes professionnels ou scolaires uniquement.	Abonnements créés par n’importe quelle application pour n’importe quel user ou pour tous les utilisateurs dans l’annuaire.

Requête HTTP

GET /subscriptions

Paramètres facultatifs de la requête

Cette méthode ne prend pas en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

En-têtes de demande

Nom	Type	Description
Autorisation	string	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un200 OKcode de réponse et une liste d’objets d’abonnement dans le corps de la réponse.

Exemple

Demande

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Subscriptions.GetAsync();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

mgc subscriptions list

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
subscriptions, err := graphClient.Subscriptions().Get(context.Background(), nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SubscriptionCollectionResponse result = graphClient.subscriptions().get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let subscriptions = await client.api('/subscriptions')
	.get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->subscriptions()->get()->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.ChangeNotifications

Get-MgSubscription

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.subscriptions.get()

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

Remarque : La réponse présentée ici peut être raccourcie pour des raisons de lisibilité.

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"
    }
  ]
}

Remarque : les valeurs de propriété clientState ne sont pas renvoyées pour des raisons de sécurité.

Lorsqu’une requête renvoie plusieurs pages de données, la réponse inclut une @odata.nextLink propriété pour vous aider à gérer les résultats. Pour plus d’informations, voir Pagination des données Microsoft Graph dans votre application.