Skip to content

Latest commit

 

History

History
207 lines (129 loc) · 12.8 KB

README.md

File metadata and controls

207 lines (129 loc) · 12.8 KB
Raw
page_type description products languages extensions
sample
Create Microsoft Graph webhook subscriptions for an ASP.NET Core app, so that it can receive notifications of changes for any resource. This sample also supports receiving change notifications with data, validating and decrypting the payload.
ms-graph
office-exchange-online
entra
entra-id
office-teams
aspx-csharp
csharp
contentType technologies services createdDate
samples
Microsoft Graph
Microsoft Teams
Azure AD
Office 365
Change notifications
3/3/2017 8:55:02 AM

Microsoft Graph Change Notifications Sample for ASP.NET Core

.NET Core

Subscribe for Microsoft Graph change notifications to be notified when your user's data changes, so you don't have to poll for changes.

This sample ASP.NET Core web application shows how to subscribe for change notifications as well as how to validate and decrypt change notifications with resource data when supported by the resource.

This sample uses:

Using the Microsoft Graph Webhooks Sample

This sample implements the following scenarios.

  • Uses user-delegated authentication to subscribe to notifications in a user's Exchange Online inbox.
  • Uses app-only authentication to subscribe to notifications for all new Teams channel messages. These notifications include encrypted resource data.

User-delegated authentication represents a user and the application being used when calling the Microsoft Graph. This type of authentication is best suited for scenarios when the user interacts with the application. Application only authentication represents only the application itself when calling the Microsoft Graph, without any notion of user. This type of authentication is best suited for background services, daemons or other kind of applications users are not directly interacting with.

See the list of permissions and authentication types permitted for each supported resource in Microsoft Graph.

Prerequisites

To use the Microsoft Graph Webhook Sample for ASP.NET Core, you need the following:

  • .NET 8.0 or later.
  • A work, or school account. Note: The app-only Teams channel scenario in the sample requires a tenant administrator account to grant application permissions for the app-only portion.
  • The application ID and secret from the application that you register on the Azure Portal.
  • A public HTTPS endpoint to receive and send HTTP requests. You can host this on Microsoft Azure or another service, or you can use ngrok or a similar tool while testing.
  • If you are also testing change notifications with resource data, you also need a Microsoft Azure subscription to create an Azure Key Vault. If you do not have a Microsoft Azure subscription, you can start a free trial.

Create the app registration

Choose the tenant where you want to create your app

  1. Sign in to the Azure portal using either a work or school account.
  2. If your account is present in more than one Azure AD tenant:
    1. Select your profile from the menu on the top right corner of the page, and then Switch directory.
    2. Change your session to the Azure AD tenant where you want to create your application.

Register the app

  1. Select Microsoft Entra ID in the left-hand navigation, then select App registrations under Manage.

  2. Select New registration. On the Register an application page, set the values as follows.

    • Set Name to ASP.NET Graph Notification Webhook Sample.
    • Set Supported account types to Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts.
    • Under Redirect URI, set the first drop-down to Web and set the value to https://localhost:5001/.

    A screenshot of the Register an application page

  3. Select Register to create the app. On the app's Overview page, copy the value of the Application (client) ID and Directory (tenant) ID and save them for later.

  4. Select Authentication under Manage. Add an additional Redirect URI with the value https://localhost:5001/signin-oidc.

  5. Set the Front-channel logout URL to https://localhost:5001/signout-oidc. Select Save.

  6. Select Certificates & secrets under Manage. Select the New client secret button. Enter a value in Description and select one of the options for Expires and select Add.

  7. Copy the Value of the new secret before you leave this page. It will never be displayed again. Save the value for later.

    A screenshot of a new secret in the Client secrets list

  8. Select API permissions under Manage.

  9. In the list of pages for the app, select API permissions, then select Add a permission.

  10. Make sure that the Microsoft APIs tab is selected, then select Microsoft Graph.

  11. Select Application permissions, then find and enable the ChannelMessage.Read.All permission. Select Add permissions to add the enabled permission.

    Note: To create subscriptions for other resources you need to select different permissions as documented here

  12. In the Configured permissions list, select the ellipses (...) in the User.Read row, and select Remove permission. The User.Read permission will be requested dynamically as part of the user sign-in process.

    A screenshot of the Remove permission menu item

  13. Select Grant admin consent for name of your organization and Yes. This grants consent to the permissions of the application registration you just created to the current organization.

Setting up Azure Key Vault

Note

The app-only scenario in this sample requires this step. It assumes that the public/private key pair for encrypting and decrypting resource data in the notification payloads are stored in Azure Key Vault. Refer to the documentation for a complete list of resources that support including resources data.

Follow the documented steps to configure your Azure KeyVault in order to add support for change notifications with resource data.

Set up the ngrok proxy (optional)

You must expose a public HTTPS endpoint to create a subscription and receive notifications from Microsoft Graph. While testing, you can use ngrok to temporarily allow messages from Microsoft Graph to tunnel to a localhost port on your computer.

You can use the ngrok web interface (http://127.0.0.1:4040) to inspect the HTTP traffic that passes through the tunnel. To learn more about using ngrok, see the ngrok website.

  1. Download ngrok.

  2. Run the following command in your command-line interface.

    ngrok http https://localhost:5001

  3. Copy the HTTPS URL that's shown in the console. You'll use this to configure your notification URL in the sample.

    The forwarding HTTPS URL in the ngrok console

Keep the console open while testing. If you close it, the tunnel also closes and you'll need to generate a new URL and update the sample.

See troubleshooting for more information about using tunnels.

Configure and run the sample

  1. Expose a public HTTPS notification endpoint. It can run on a service such as Microsoft Azure, or you can create a proxy web server by using ngrok or a similar tool.

  2. Open appsettings.json in the root directory of the project.

    Note: During development, it's recommended that you use the .NET Secret Manager to store secrets instead of putting them in appsettings.json.

    • Settings under AzureAd:
      • TenantId: Your tenant ID (obtained when registering the application)
      • ClientId: Your application ID (obtained when registering the application)
      • ClientSecret: Your client secret (obtained when registering the application) RECOMMENDED: set this in Secret Manager instead: dotnet user-secrets set AzureAd:ClientSecret "YOUR_CLIENT_SECRET".
    • GraphScopes: The Graph permission scopes used in the user-delegated scenario. These are already set for the user's inbox scenario. You'll need to change these if you subscribe to a different resource.
    • NotificationHost: Set to the host name of the server that hosts your application. During local development, set this to your ngrok URL.
    • Settings under KeyVault:
      • Url: The URL to your Azure Key Vault
      • CertificateName The name of the certificate in your Azure Key Vault

  3. Make sure that the ngrok console is still running, then run the app with the following command.

    dotnet run

    Note: You can use Visual Studio Code to set breakpoints and run the sample in debug mode.

Use the app to create a subscription

Use delegated authentication to subscribe to a user's inbox

  1. Choose the Sign in and subscribe button and sign in with a work or school account.

  2. Review and consent to the requested permissions. The subscription is created and you are redirected to a page displaying any notification being received.

  3. Send an email to yourself. A notification appears showing the subject and message ID.

    A screenshot of the user inbox notifications page

Use app-only authentication to subscribe to Teams channel messages

  1. If you previously subscribed to a user's inbox, choose the Delete subscription button to return to the home page.

  2. Choose the Subscribe button. The subscription is created and you are redirected to a page displaying any notification being received.

  3. Post a message to a channel in any team in Microsoft Teams. A notification appears showing the sender's name and the message.

    A screenshot of the Teams channel notifications page

Troubleshooting

See the dedicated troubleshooting page.

Contributing

If you'd like to contribute to this sample, see CONTRIBUTING.MD.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Questions and comments

We'd love to get your feedback about the Microsoft Graph Webhooks sample for ASP.NET Core. You can send your questions and suggestions to us in the Issues section of this repository.

Questions about Microsoft Graph in general should be posted to Microsoft Q&A. Make sure that your questions or comments are tagged with the relevant Microsoft Graph tag.

Additional resources