Partner API for AI Business Solutions & Security Insights API Onboarding Guide

Note

This API provides access to the AI Business Solutions & Security Insights report. For all other Partner Center data scenarios, see Partner Center REST APIs.


Overview

To get started, complete a one-time onboarding and setup process. This process includes completing the onboarding form, provisioning required service principals, registering an app in Microsoft Entra ID, configuring API permissions and authentication, and adding the app in the Partner API management portal.

Getting started

  1. Complete the Partner API Onboarding Form.

    • A Partner Center Global Admin must complete this form.
    • You receive a confirmation email from PXPartnerSupport@microsoft.com once your onboarding is complete.

  2. Use Microsoft Graph Explorer to create the required Microsoft 365 Partner API service principals in your tenant. This one-time setup is required to complete onboarding.

    1. Go to Graph Explorer.
    2. Make sure you're signed in by using an account with one of the following Azure AD roles:
      • Global Administrator
      • Application Developer
      • Application Administrator
      • Cloud Application Administrator
      • Hybrid Identity Administrator

    Request 1: Microsoft 365 Partner API

    In Graph Explorer:

    1. Change the HTTP method to POST.
    2. Enter the following URL: https://graph.microsoft.com/v1.0/servicePrincipals.
    3. Select the Request Body tab and paste the following JSON: "appId": "7b388e5c-7dea-4e0b-bc73-415971207918".
    4. Under Modify permissions, review, and consent to the requested permissions.
    5. Select Run Query.

    Example:

    Screenshot showing an example in Graph Explorer.

    Request 2: M365-Partner-API-Admin-App

    Repeat the same steps using this Request Body: "appId": "c584e1eb-b862-4992-b2f7-c2a94b4331a0".

    Both requests must be executed successfully to provision the required service principals in your tenant.

  3. Register an app in Microsoft Entra ID by following these steps:

    • In the Azure portal, go to Microsoft Entra ID > App registrations > New registration. Create the app, and then complete the registration.

  4. Add Microsoft 365 Partner API permissions by following these steps:

    1. Open the app registration, and go to API permissions > Add permissions > APIs my organization uses.
    2. Search for M365 Partner API.
    3. For user access, select Delegated permissions; for application access, select Application permissions.
    4. Select the appropriate permission, select Add permissions, and then grant admin consent if necessary.

  5. Configure authentication by following these steps:

    • In the same app registration, open Authentication, add your Redirect URL, and ensure Access tokens are enabled.

  6. Go to https://management.m365partner.microsoft.com and add your app to the Application Management section.

Support

If you encounter problems with onboarding or API access, contact the support team at PXPartnerSupport@microsoft.com.

Include the following information:

  • Partner name
  • MPN IDs
  • Tenant ID for your program membership
  • A brief description of your problem
  • Last updated on