Configure terms of service and privacy statement for an app

Članak
06/01/2022
2 min. za čitanje

Developers who build and manage multi-tenant apps that integrate with Azure Active Directory (Azure AD) and Microsoft accounts should include links to the app's terms of service and privacy statement. The terms of service and privacy statement are surfaced to users through the user consent experience. They help your users know that they can trust your app. The terms of service and privacy statement are especially critical for user-facing multi-tenant apps--apps that are used by multiple directories or are available to any Microsoft account.

You are responsible for creating the terms of service and privacy statement documents for your app, and for providing the URLs to these documents. For multi-tenant apps that fail to provide these links, the user consent experience for your app will show an alert, which may discourage users from consenting to your app.

Note

The terms of service and privacy statement links are not applicable to single-tenant apps
If one or both of the two links are missing, your app will show an alert.

The following example shows the user consent experience for a multi-tenant app when the terms of service and privacy statement are configured and when these links are not configured.

Screenshots with and without a privacy statement and terms of service provided

Formatting links to the terms of service and privacy statement documents

Before you add links to your app's terms of service and privacy statement documents, make sure the URLs follow these guidelines.

Guideline	Description
Format	Valid URL
Valid schemas	HTTP and HTTPS We recommend HTTPS
Max length	2048 characters

Examples: https://myapp.com/terms-of-service and https://myapp.com/privacy-statement

Adding links to the terms of service and privacy statement

When the terms of service and privacy statement are ready, you can add links to these documents in your app using one of these methods:

Through the Azure portal
Using the app object JSON
Using the Microsoft Graph API

Using the Azure portal

Follow these steps in the Azure portal.

Sign in to the Azure portal and select the correct Azure AD tenant(not B2C).
Navigate to the App registrations section and select your app.
Under Manage, select Branding.
Fill out the Terms of service URL and Privacy statement URL fields.
Select Save.

Using the app object JSON

If you prefer to modify the app object JSON directly, you can use the manifest editor in the Azure portal or Application Registration Portal to include links to your app's terms of service and privacy statement.

Navigating to the App Registrations section and select your app.
Open the Manifest pane.
Ctrl+F, Search for "informationalUrls". Fill in the information.
Save your changes.

    "informationalUrls": { 
        "termsOfService": "<your_terms_of_service_url>", 
        "privacy": "<your_privacy_statement_url>" 
    }

Using the Microsoft Graph API

To programmatically update all your apps, you can use the Microsoft Graph API to update all your apps to include links to the terms of service and privacy statement documents.

PATCH https://graph.microsoft.com/v1.0/applications/{application id}
{ 
    "appId": "{your application id}", 
    "info": { 
        "termsOfServiceUrl": "<your_terms_of_service_url>", 
        "supportUrl": null, 
        "privacyStatementUrl": "<your_privacy_statement_url>", 
        "marketingUrl": null, 
        "logoUrl": null 
    }
}