サブスクリプションを一覧表示する

[アーティクル]
06/22/2024

名前空間: microsoft.graph

アプリ ID、ユーザー、およびテナントでのユーザーの役割に基づいて、Webhook サブスクリプションのプロパティとリレーションシップを取得します。

応答の内容は、アプリが呼び出しているコンテキストによって異なります。詳細については、「アクセス許可セクションのシナリオ」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API は、次のアクセス許可スコープをサポートしています。アクセス許可の選択方法などに関する詳細については、「アクセス許可」を参照してください。

サポートされているリソース	委任 (職場または学校のアカウント)	委任 (個人用 Microsoft アカウント)	アプリケーション
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
チャネル (/teams/getAllChannels – 組織内のすべてのチャネル)	非サポート	非サポート	Channel.ReadBasic.All、ChannelSettings.Read.All
チャネル (/teams/{id}/channels)	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	非サポート	Channel.ReadBasic.All、ChannelSettings.Read.All
チャット (/chats – 組織内のすべてのチャット)	サポート対象外	非サポート	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
チャット /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 -- all channel messages in organization)	非サポート	非サポート	ChannelMessage.Read.All
chatMessage (/chats/{id}/messages)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	非サポート	Chat.Read.All
chatMessage (/chats/getAllMessages -- all chat messages in organization)	非サポート	非サポート	Chat.Read.All
チャットメッセージ (/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
イベント	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
グループ	Group.Read.All, Subscription.Read.All	サポート対象外	Group.Read.All
グループ会話	Group.Read.All, Subscription.Read.All	サポート対象外	非サポート
リスト	Sites.ReadWrite.All, Subscription.Read.All	サポート対象外	Sites.ReadWrite.All
メッセージ	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.Read.All, Subscription.Read.All	非サポート	サポート対象外
プリンター	非サポート	非サポート	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	非サポート	非サポート	PrintTaskDefinition.ReadWrite.All
セキュリティの警告	SecurityEvents.ReadWrite.All, Subscription.Read.All	サポート対象外	SecurityEvents.ReadWrite.All
シフト (/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
team (/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

応答の結果は、呼び出し元アプリのコンテキストによって異なります。以下のセクションでは、一般的なシナリオについて説明します。

基本シナリオ

ほとんどの場合、アプリケーションは、現在サインインしているユーザーかディレクトリ (職場アカウントや学校アカウント) 内のすべてのユーザーに対してそのアプリケーションが元々作成していたサブスクリプションを取得しようとします。これらのシナリオでは、アプリがサブスクリプションを作成するために最初に使用したアクセス許可を超える特別なアクセス許可は必要ありません。

呼び出し元アプリのコンテキスト	応答内容
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。 - および - サブスクリプションの作成に必要な元のアクセス許可をアプリが持っている。注: これは、個人用の Microsoft アカウントと職場や学校のアカウントの両方に適用されます。	このアプリによって作成された、サインインユーザーのみのサブスクリプション。
アプリがそのアプリのために呼び出しを実行している (アプリケーションのアクセス許可)。 - および - サブスクリプションの作成に必要な元のアクセス許可をアプリが持っている。注: これは、職場や学校のアカウントにのみ適用されます。	このアプリによって作成された、アプリ自体またはディレクトリ内の任意のユーザーのサブスクリプション。

高度なシナリオ

場合によっては、アプリは、他のアプリによって作成されたサブスクリプションを取得しようとします。たとえば、ユーザーが、自分に代わって任意のアプリによって作成されたすべてのサブスクリプションを確認しようとすることがあります。または、グローバル管理者は、ディレクトリ内のすべてのアプリのすべてのサブスクリプションを表示したい場合があります。このような場合、委任されたアクセス許可の Subscription.Read.All が必要になります。

呼び出し元アプリのコンテキスト	応答内容
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。ユーザーは管理者ではない。 - および - Subscription.Read.All アクセス許可をアプリが持っている注: これは、個人用の Microsoft アカウントと職場や学校のアカウントの両方に適用されます。	任意のアプリによって作成された、サインインユーザーのみのサブスクリプション。
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。ユーザーはグローバル管理者です。 - および - Subscription.Read.All アクセス許可をアプリが持っている注: これは、職場や学校のアカウントにのみ適用されます。	任意のアプリによって作成された、ディレクトリ内の任意のユーザーのサブスクリプション。

HTTP 要求

GET /subscriptions

オプションのクエリパラメーター

このメソッドは、応答のカスタマイズに役立つ OData クエリパラメーターをサポートしていません。

要求ヘッダー

名前	種類	説明
Authorization	string	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で subscription オブジェクトの一覧を返します。

例

要求

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


// 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();



mgc subscriptions list



// 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)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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


const options = {
	authProvider,
};

const client = Client.init(options);

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


<?php
use Microsoft\Graph\GraphServiceClient;


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


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


Import-Module Microsoft.Graph.ChangeNotifications

Get-MgSubscription


# 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()

応答

次の例は応答を示しています。

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

複数ページにわたるデータを要求が返す場合は、結果を管理しやすくするため、応答に @odata.nextLink プロパティが含まれます。詳細については、「アプリで Microsoft Graph データをページングする」を参照してください。

次の方法で共有

サブスクリプションを一覧表示する

アクセス許可

基本シナリオ

高度なシナリオ

HTTP 要求

オプションのクエリパラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

次の方法で共有

サブスクリプションを一覧表示する

アクセス許可

基本シナリオ

高度なシナリオ

HTTP 要求

オプションのクエリ パラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

オプションのクエリパラメーター