Entitlement Data for Eligible Games
Please note that, pursuant to the Commitments entered into by Microsoft and made legally binding by the European Commission in its decision under Article 8(2) of Regulation (EC) 139/2004 in case M. 10646 - Microsoft/Activision Blizzard ("Commitments"), Microsoft committed to provide Streaming Services serving customers in the European Economic Area, with Consumer consent, access to Entitlement Data (e.g., whether a Consumer has already purchased an Eligible Game or whether a consumer is an active subscriber to a multi-game subscription service that includes an Eligible Game) through a standard interface. This obligation is limited to Streaming Services that are already licensed to provide cloud game streaming by at least one Major Game Publisher at the time the Streaming Service seeks access to a Microsoft Game Store. Should a cloud game streaming provider want to avail itself of this provision, it should fill out the streaming provider pplication here. For more information on this, please see the full text of the EC Commitments on the European Commission’s website. For additional frequently asked questions about the EC Commitments, see Activision Blizzard Cloud Game Streaming in the European Economic Area FAQ
As Eligible Activision Blizzard games may be available on both Battle.net and/or the Microsoft Store, there are two separate Entitlement endpoints for streaming providers to call for comprehensive Entitlement Data. For both APIs, streaming providers will need to perform secure Service-to-Service (S2S) with OAuth Credentials. Providers will need to share their Azure Application App ID and Tenant ID with Microsoft and Blizzard to allow list the Provider's application as a secure caller. To learn more about this pattern, learn how to Configure protected web API apps.
When streaming providers avail themselves of the Streaming Provider License, they will also attest to following certain Data Protection Agreements if they decide to request customer Entitlement Data. This request requires user consent to share Entitlement Data from each Store with the provider, which the provider must request as outlined in each API's documentation.
This page will document the Entitlement API for Microsoft Store Entitlement Data of Eligible Activision Blizzard games and subgames. For documentation on the Battle.net Entitlement API, please read more here.
The following definitions apply, as per the Commitments:
“Consumers” include consumers based in the EEA who are licensed to play Eligible Games for their personal use pursuant to the Consumer License.
“Streaming Service” includes a cloud game streaming service that allows Consumers to play, from the service provider’s cloud-based servers, PC or console games for which the Consumers have already obtained a license for the game (including through either buy-to-play, free-to-play, or subscription).
“Major Game Publisher” refers to Tencent, Valve Corporation, Nexon, NetEase, EA, SmileGate Embracer (THQ) - Perfect World, Roblox Corporation, Take Two, Epic Games, Ubisoft, Square Enix, Bandai Namco Entertainment, Sony and Nintendo.
Entitlement Data Application and Onboarding
If you are a Streaming Provider looking to obtain Entitlement Data from Microsoft and Battle.net, please follow the steps below. If you encounter any issues, you can send an email to abkstreaming@microsoft.com for help:
- Apply for Entitlement Data via the Streaming Provider License form, or email the game streaming provider email alias, abkstreaming@microsoft.com.
- Review the API documentation on the Azure Gaming learning site (this page) and Battle.net Developer Portal.
- Create a free Azure account if you do not have one already. For step-by-step tutorial, see - Create an Azure account.
- Create a free Azure Application on Azure.com.
- Follow the steps below in Azure App Configuration with MSA v2 before the next step!
- Send your Azure Application ID and Tenant ID to the game streaming provider email alias, abkstreaming@microsoft.com.
- We'll confirm that your application has been added to the allow list. This allows your application to call the Entitlement APIs. Credentials will be provided via email.
- Streaming Provider may now call Entitlement APIs from their application.
Azure App Configuration with MSA v2
If you have not previously created an Azure Application to leverage secure service-to-service calls and user authentication, follow these steps before going back to step 5 above:
- Go to your Azure portal, select App Registration. Provide a friendly name for your application. This app name will be shown users in your game streaming client during collecting user consent to share their entitlement data with you (consent dialog example shown below).
- For Supported Account Type, select Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)
- Under Redirect URI, provide a suitable redirect URI. For testing purposes, select Web and enter https://oauth.pstmn.io/v1/callback to use Postman.
After registering your Azure Application, configure your secret. For testing using Postman, you can use a client secret. For production, we recommended that you use a certificate.
After creating the secret, send the Application (Client) ID and Azure Tenant ID to abkstreaming@microsoft.com for secure access to the Microsoft Store and Battle.net endpoints.
Streaming Providers will also need to trigger a consent dialog for a user to consent to sharing their Entitlement Data from each Store (Microsoft Store, Battle.net) by calling the authorization endpoint with a particular Scope. The screenshot below shows an example dialog.
Information on how to call the endpoint with the correct Scopes will be shared directly with the Streaming Provider over email (step 6 above).