How to request access to Microsoft Graph Teams Export APIs

KB ID: 4322
Product: Veeam Backup for Microsoft 365 | 6.0
Published: 2022-06-11
Last Modified: 2022-10-14
Get weekly article updates
By subscribing, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.

Cheers for trusting us with the spot in your mailbox!

Now you’re less likely to miss what’s been brewing in our knowledge base with this weekly digest

error icon

Oops! Something went wrong.

Please try again later.

Preliminary Action

This article documents how to request Microsoft Graph Export API for Teams access, which is needed to enable Veeam Backup for Microsoft 365 6a to utilize that API to protect Teams Chats.

After Microsoft has approved access to the Teams Protected APIs and Veeam Backup for Microsoft 365 6a is installed, follow the steps in KB4340 to enable the use of those APIs to protect Teams Chats.

Purpose

Veeam Backup for Microsoft 365 6a provides an option to leverage Microsoft Graph Export API for Teams to back up Teams public channel messages. However, because these APIs access sensitive data, they are considered protected APIs, and to access these APIs, the backup administrator must fill out a form to request access from Microsoft. This Veeam KB article documents what information the Microsoft form (Request access to protected APIs) requires.

Support for Microsoft Graph Export API for Teams was implemented in Veeam Backup for Microsoft 365 6a because soon Microsoft will deprecate the ability for EWS APIs to access the TeamsMessagesData folder. By default Veeam Backup for Microsoft 365 6a and previous versions utilized EWS APIs to protect the TeamsMessagsesData folder. After Microsoft deprecates EWS API access to the TeamsMessagesData folder, the only way to backup Teams public channel message using Veeam Backup for Microsoft 365 will be to utilize the Teams Export APIs.

Important Notes:

  • To protect Teams message data, additional steps must be performed, and then the Teams backup must be explicitly enabled.
  • Utilizing the Microsoft Graph Export API for Teams comes at an additional cost from Microsoft. *Veeam Backup for Microsoft 365 6a's API request will be considered as "model=B"
  • Microsoft's onboarding process for access to the Graph Export API may take up to two weeks to be processed. As such, it is advisable to begin the process of requesting API access as soon as possible.
  • The Microsoft Graph Export API for Teams is currently not supported in Microsoft 365 US Government, Germany, and China regions.

 

Solution

Register App and Collect Information for API Request Form

When adding an organization with modern authentication to Veeam Backup for Microsoft 365, after following the login prompts, you will end up with an app registration. You will need information about this app registration to request Protected API access in the next section.

  1. Log into portal.azure.com and select Azure Active Directory.
    If your account has access to more than one directory, ensure you have selected the relevant one.
  2. Under Azure Active Directory overview, gather the Tenant ID.
  3. In the Veeam Backup for Microsoft 365 Console, right-click the Organization and select 'Edit organization'. Gather the Application ID.
  4. Under App Registrations in Azure AD, review the API permissions assigned to the app registration used.
    Ensure that the Microsoft Graph Application permission to ChannelMessage.Read.All is assigned.

Request API Access

As documented in Protected APIs in Microsoft Teams:
To request access to these protected APIs, complete the following request form

Note: Microsoft's review process may take up to two weeks to be completed.

Form Fields

To simplify the request process, Veeam has documented the fields you will fill out to request Protected API access. Where possible text below will have a copy button so that you can easily paste the text into the form. Each step number below correlates to the numbered entry in the "Request access to protected APIs " form (as of 2022-08-09).
If you notice that the Microsoft form has changed and no longer aligns with the information below, please Send KB Feedback.
 

  1. Your email address and any others you want to list as an owner — Enter an email address for the organization you wish to protect.
  2. Publisher name:
Veeam Software Corporation
  1. Application name:
Veeam Backup for Microsoft 365
  1. Application ID(s) to enable permissions/subscription for — Enter the application id you gathered earlier
  2. Azure billing subscription ID as GUID, this subscription must be under the same tenant. — Enter the Subscription ID
  3. Which category best describes your applicationBackup/restore
  4. Why does your application need read access to all messages in the tenant?:
For backup and compliance purposes
  1. Data retention (select one):
    • It is obvious to any admin installing this app that it will make a copy of Microsoft Teams messages.
  2. What are the tenant ID's that this application needs to run in? — Enter the tenant id you gathered earlier.
  3. Does your organization own all those tenants?  — Yes


Click [ Next ]
 

  1. May we contact you about your app's use of non-protected APIs? (E.g., Azure subscription verification, reliability issues, advanced notice of breaking changes, throttling, etc). — Yes
  2. I have read and agree to the Terms and Conditions for Licensing and payment requirements that apply to these APIs (Service Specific Terms in the link below). Selecting "No" will reject your request.  — Yes


Click [ Submit ]

 

To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.

Spelling error in text

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.
Thank you!

Thank you!

Your feedback has been received and will be reviewed.

Oops! Something went wrong.

Please try again later.

KB Feedback/Suggestion

This form is only for KB Feedback/Suggestions, if you need help with the software open a support case

By submitting, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.
Verify your email to continue your product download
We've sent a verification code to:
  • Incorrect verification code. Please try again.
An email with a verification code was just sent to
Didn't receive the code? Click to resend in sec
Didn't receive the code? Click to resend
Thank you!

Thank you!

Your feedback has been received and will be reviewed.

error icon

Oops! Something went wrong.

Please try again later.