subscription: reauthorize

Namespace: microsoft.graph

Reauthorize a subscription when you receive a reauthorizationRequired challenge.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. To learn more, including taking caution before choosing more privileged permissions, search for the following permissions in Permissions.

Note:

Some resources support change notifications in multiple scenarios, each of which may require different permissions. In those cases, use the resource path to differentiate the scenarios.

Permissions marked with * use resource-specific consent.

Supported resource	Delegated (work or school account)	Delegated (personal Microsoft account)	Application
baseTask (deprecated)	Tasks.ReadWrite	Tasks.ReadWrite	Not supported.
callRecord	Not supported.	Not supported.	CallRecords.Read.All
callRecording communications/onlineMeetings/getAllRecordings All recordings in an organization.	Not supported.	Not supported.	OnlineMeetingRecording.Read.All
callRecording communications/onlineMeetings/{onlineMeetingId}/recordings All recordings for a specific meeting.	OnlineMeetingRecording.Read.All	Not supported.	OnlineMeetingRecording.Read.All
callRecording users/{userId}/onlineMeetings/getAllRecordings A call recording that becomes available in a meeting organized by a specific user.	OnlineMeetingRecording.Read.All	Not supported.	OnlineMeetingRecording.Read.All
callTranscript communications/onlineMeetings/getAllTranscripts All transcripts in an organization.	Not supported.	Not supported.	OnlineMeetingTranscript.Read.All
callTranscript communications/onlineMeetings/{onlineMeetingId}/transcripts All transcripts for a specific meeting.	OnlineMeetingTranscript.Read.All	Not supported.	OnlineMeetingTranscript.Read.All
callTranscript users/{userId}/onlineMeetings/getAllTranscripts A call transcript that becomes available in a meeting organized by a specific user.	OnlineMeetingTranscript.Read.All	Not supported.	OnlineMeetingTranscript.Read.All
channel /teams/getAllChannels All channels in an organization.	Not supported.	Not supported.	Channel.ReadBasic.All, ChannelSettings.Read.All
channel /teams/{id}/channels All channels in a particular team in an organization.	Channel.ReadBasic.All, ChannelSettings.Read.All	Not supported.	Channel.ReadBasic.All, ChannelSettings.Read.All
chat /chats All chats in an organization.	Not supported.	Not supported.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat /chats/{id} A particular chat.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite	Not supported.	ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat /appCatalogs/teamsApps/{id}/installedToChats All chats in an organization where a particular Teams app is installed.	Not supported	Not supported	Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chatMessage /teams/{id}/channels/{id}/messages All messages and replies in a particular channel.	ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All	Not supported.	ChannelMessage.Read.Group*, ChannelMessage.Read.All
chatMessage /teams/getAllMessages All channel messages in organization.	Not supported.	Not supported.	ChannelMessage.Read.All
chatMessage /chats/{id}/messages All messages in a chat.	Chat.Read, Chat.ReadWrite	Not supported.	Chat.Read.All
chatMessage /chats/getAllMessages. All chat messages in an organization.	Not supported.	Not supported.	Chat.Read.All
chatMessage /users/{id}/chats/getAllMessages Chat messages for all chats a particular user is part of.	Chat.Read, Chat.ReadWrite	Not supported.	Chat.Read.All, Chat.ReadWrite.All
chatMessage /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages Chat messages for all chats in an organization where a particular Teams app is installed.	Not supported	Not supported	Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact	Contacts.Read	Contacts.Read	Contacts.Read
conversationMember /chats/getAllMembers Members of all chats in an organization.	Not supported.	Not supported.	ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember /chats/{id}/members Members of a particular chat.	ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite	Not supported.	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 Chat members for all chats in an organization where a particular Teams app is installed.	Not supported.	Not supported.	ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember /teams/getAllMembers Members in all teams in an organization.	Not supported.	Not supported.	TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember /teams/{id}/members Members in a particular team.	TeamMember.Read.All	Not supported.	TeamMember.Read.All
conversationMember /teams/{id}/channels/getAllMembers Members in all private channels of a particular team.	Not supported.	Not supported.	ChannelMember.Read.All
conversationMember (/teams/getAllChannels/getAllMembers)	Not supported.	Not supported.	ChannelMember.Read.All
driveItem (user's personal OneDrive)	Not supported.	Files.ReadWrite	Not supported.
driveItem (OneDrive for Business)	Files.ReadWrite.All	Not supported.	Files.ReadWrite.All
event	Calendars.Read	Calendars.Read	Calendars.Read
group	Group.Read.All	Not supported.	Group.Read.All
group conversation	Group.Read.All	Not supported.	Not supported.
list	Sites.ReadWrite.All	Not supported.	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read	Mail.ReadBasic, Mail.Read	Mail.Read
offerShiftRequest (/teams/{id}/schedule/offerShiftRequests) Changes to any offer shift request in a team.	Schedule.Read.All, Schedule.ReadWrite.All	Not supported.	Schedule.Read.All, Schedule.ReadWrite.All
openShiftChangeRequest (/teams/{id}/schedule/openShiftChangeRequests) Changes to any open shift request in a team.	Schedule.Read.All, Schedule.ReadWrite.All	Not supported.	Schedule.Read.All, Schedule.ReadWrite.All
online meeting	Not supported	Not supported	OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All
presence	Presence.Read.All	Not supported.	Not supported.
printer	Not supported.	Not supported.	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	Not supported.	Not supported.	PrintTaskDefinition.ReadWrite.All
security alert	SecurityEvents.ReadWrite.All	Not supported.	SecurityEvents.ReadWrite.All
shift (/teams/{id}/schedule/shifts) Changes to any shift in a team.	Schedule.Read.All, Schedule.ReadWrite.All	Not supported.	Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest (/teams/{id}/schedule/swapShiftsChangeRequests) Changes to any swap shift request in a team.	Schedule.Read.All, Schedule.ReadWrite.All	Not supported.	Schedule.Read.All, Schedule.ReadWrite.All
team /teams All teams in an organization.	Not supported.	Not supported.	Team.ReadBasic.All, TeamSettings.Read.All
team /teams/{id} A particular team.	Team.ReadBasic.All, TeamSettings.Read.All	Not supported.	Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest (/teams/{id}/schedule/timeOffRequests) Changes to any time off request in a team.	Schedule.Read.All, Schedule.ReadWrite.All	Not supported.	Schedule.Read.All, Schedule.ReadWrite.All
todoTask	Tasks.ReadWrite	Tasks.ReadWrite	Not supported.
user	User.Read.All	User.Read.All	User.Read.All

chatMessage

chatMessage subscriptions can be specified to include resource data. If specified to include resource data (includeResourceData set to true), encryption is required. The subscription creation fails if an encryptionCertificate isn't specified for such subscriptions.

You must use the Prefer: include-unknown-enum-members request header to get the following values in chatMessage messageType evolvable enum: systemEventMessage for /teams/{id}/channels/{id}/messages and /chats/{id}/messages resource.

Note

/teams/getAllMessages, /chats/getAllMessages, /me/chats/getAllMessages, /users/{id}/chats/getAllMessages, and /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages are metered APIs; payment models and licensing requirements may apply. /teams/getAllMessages and /chats/getAllMessages support both model=A and model=B payment models, /me/chats/getAllMessages, /users/{id}/chats/getAllMessages, and /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages support only model=B. If you don't specify a payment model in your query, the default evaluation mode will be used.

Note

To add or change a payment model for a subscribed resource of a change notification, you must create a new change notification subscription with the new payment model; updating an existing change notification does not work.

conversationMember

conversationMember subscriptions can be specified to include resource data. If specified to include resource data (includeResourceData set to true), encryption is required. The subscription creation fails if an encryptionCertificate isn't specified.

Note

/teams/getAllMembers, /chats/getAllMembers, and /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers are metered APIs; payment models and licensing requirements may apply. /teams/getAllMembers and /chats/getAllMembers support both model=A and model=B payment models. /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers supports only model=B. If you don't specify a payment model in your query, the default evaluation mode will be used.

Note

To add or change a payment model for a subscribed resource of a change notification, you must create a new change notification subscription with the new payment model; updating an existing change notification does not work.

team, channel, and chat

team, channel, and chat subscriptions can be specified to include resource data. If specified to include resource data (includeResourceData set to true), encryption is required. The subscription creation fails if an encryptionCertificate isn't specified.

You can use the notifyOnUserSpecificProperties query string parameter when you subscribe to changes in a particular chat or at user level. When you set the query string parameter notifyOnUserSpecificProperties to true during subscription creation, two types of payloads are sent to the subscriber. One type contains user-specific properties, and the other is sent without them. For more information, see Get change notifications for chats using Microsoft Graph.

Note

/appCatalogs/teamsApps/{id}/installedToChats has licensing and payment requirements, specifically supporting only model=B. If no model is specified, evaluation mode will be used.

Note

To add or change a payment model for a subscribed resource of a change notification, you must create a new change notification subscription with the new payment model; updating an existing change notification does not work.

Request example

Specify the model query parameter in the resource property in the request body.

POST https://graph.microsoft.com/v1.0/subscriptions
Content-type: application/json

{
   "changeType": "created",
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
   "resource": "chats/getAllMessages?model=A",
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
   "clientState": "secretClientValue",
   "latestSupportedTlsVersion": "v1_2"
}

HTTP request

POST /subscriptions/{subscriptionsId}/reauthorize

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this action returns a 204 No Content response code.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/subscriptions/{subscriptionsId}/reauthorize

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
await graphClient.Subscriptions["{subscription-id}"].Reauthorize.PostAsync();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc subscriptions reauthorize post --subscription-id {subscription-id}

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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
graphClient.Subscriptions().BySubscriptionId("subscription-id").Reauthorize().Post(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.subscriptions().bySubscriptionId("{subscription-id}").reauthorize().post();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/subscriptions/{subscriptionsId}/reauthorize')
	.post();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


$graphServiceClient->subscriptions()->bySubscriptionId('subscription-id')->reauthorize()->post()->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.ChangeNotifications

Invoke-MgReauthorizeSubscription -SubscriptionId $subscriptionId

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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

await graph_client.subscriptions.by_subscription_id('subscription-id').reauthorize.post()

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content