Microsoft Entra ID
Developer

Prerequisites to validate and publish your app

In brief

The documentation separates shared prerequisites from SSO and SCIM requirements, with dedicated guidance for each capability. Applications supporting both must complete validation for both.

What Entra admins need to know

Use the capability-specific requirement pages when evaluating or preparing applications for Microsoft Entra App Gallery submission.

This editorial summary was generated by AI from the documentation changes. Verify important details in the full Microsoft Learn article.

Documentation change

The comparison below shows only the changed extract. Use the full-page view for complete context.

Prerequisites to validate and publish your app

You can publish applications you develop in the Microsoft Entra application gallery, whichApp Gallery is a catalog of thousands of apps.applications. When you publishMicrosoft publishes your applications, they're made publicly available for users toapplication in the gallery, customers can discover it and add it to their tenants. For more information, see Overview of Microsoft Entra App Gallery.

To publishBefore you validate your application inapplication, review the Microsoft Entra application gallery,shared prerequisites and the requirements for each capability that you needplan to complete the following prerequisites. publish.

PrerequisitesChoose the capabilities to publish

To publishReview the requirements that apply to your application in the gallery, you must first read and agree to specific terms and conditions.application:

  • Implement support for single sign-on (SSO). To learn more about supported options,For Security Assertion Markup Language (SAML) or OpenID Connect (OIDC) integration, see Plan a single sign-on deploymentSSO requirements for Microsoft Entra App Gallery.

    If your application requires extra per-instance configuration, such as customers needing to control their own secretssupports both SSO and certificates or instance configuration then you can publish a single-tenant Open ID Connect application. This type of application publishing is also supported inuser provisioning, complete the Microsoft Entra app gallery now. But the recommended option is to have a multitenant application in a true SaaS model.

  • Provisioning is optional yet highly recommended. To learn more about Microsoft Entra SCIM, see build a SCIM endpoint and configure user provisioning with Microsoft Entra ID

  • To implement support of SCIM 2.0 Provisioning follow this tutorial: build a SCIM endpoint and configure user provisioning with Microsoft Entra ID

    • If you already support SCIM 2.0 in your application, then you must support client credentials flowrequirements and validation for authentication in SCIM. We aren't onboarding applications that use basic authentication, long lived bearer tokens or using code grants for authentication. Use the OAuth 2.0 client credentials grant flow.
    • Additionally you also need to test the provisioning implementation using the non-gallery application in Microsoft Entra ID. You can also test the Client Credentials flow using non-gallery application template. You can learn more about it from here: Test user provisioning with a non-gallery application
  • You can sign up for a free, test Development account. It's free for 90 days and you get all of the premium Microsoft Entra features with it. You can also extend the account if you use it for development work: Join the Microsoft 365 Developer Program.both capabilities.

    Checklist for applications that support SSO

    Review this checklist before you submit a request to list your application in the Microsoft Entra application gallery.

    SAML SSO requirements

    These requirements apply to SAML-based single sign-on (SSO) applications.

    Your application must meet the following authentication requirements:

    • Application should support SAML 2.0 Protocol either in Service Provider initiated mode or Identity Provider Initiated (IDP) mode or both (Required)
    • Application should validate the SAML token for certificate key, certificate validity, Issuer, Audience and other user claims as needed. (Required)
    • Test your SAML integration with Microsoft Entra ID using a non-gallery application. (Required).
    • Applications should support SAML Single Logout functionality. (Recommended)
    • Application should fetch the IDP SAML federation metadata from Microsoft Entra ID using the link that Microsoft provides. This helps reduce the configuration overload for customers and certificate rotation. See the certificate rotation guidance. (Recommended).
    • Application should provide the user interface and APIs for customers to configure the single sign-on for their instance of the application. (Recommended)
    • Application should provide an ability to enforce the SSO functionality to the entire tenant so that all the users must use single sign-on. For administrators, and to support break glass scenarios, you can support other authentication options or bypass mechanisms as needed. (Recommended).

    As an independent software vendor (ISV), your application must also meet these requirements:

    • Application should be published in SaaS application model in cloud or distributed to customers for their installation (IaaS) so that the application can be owned and configured by customers as needed. (Required)
    • Establish an engineering and support point of contact to support customers during App Gallery onboarding and post onboarding (Required)
    • Document your SAML SSO configuration publicly (Required)
    • Meet the various compliance requirements for listing your application in those clouds like Public, USGov, China, Germany, France, Singapore etc. This is only required if you plan to publish your application in those clouds. (Required)

    Multitenant OIDC SSO requirements

    These requirements apply to multitenant OpenID Connect (OIDC) SSO applications.

    Your application must meet the following authentication requirements:

    • Application should support OpenID Connect protocol for authentication as per the guidance Microsoft provides. We recommend using the OAuth 2.0 Auth Code Grant flow. Microsoft recommends you do not use OAuth 2.0 Resource owner Password Credentials flow. Similarly, OAuth 2.0 device authorization grant flow should not be used unless explicitly needed. (Required)
    • If you are developing a cloud application, then Microsoft recommends setting the application as a multitenant application. Please see the guidance on converting your app to multitenant. (either single tenant or multitenant model is required)
    • If the cloud application is set up for every customer using IaaS or PaaS architecture then the single tenant application model is acceptable.
    • Use Microsoft Entra ID V2 endpoint for authentication (Required)
    • Application should be using least privileged permissions for their scenarios. Please refer to our MS Graph API documentation to find the least privileged permission for the APIs. (Required)
    • Application should be using delegated permissions so that the consent screen can appear and let user or administrator provide the consent to it as needed. Application Permissions should be avoided unless absolutely needed. (Required if using MS Graph APIs)
    • Application should not be using secrets if the application wants to use client credentials flow, then the certificate should be used instead of secrets for retrieving the access token. (Required)
    • SPA applications shouldn't use the OAuth 2.0 Implicit Grant Flow for security reasons and they should use authorization code flow instead. (Recommended).

    As an ISV, your application must also meet these requirements:

    • Application should be published in SaaS application model whether in cloud or distributed to customers for their installation so that the application can be owned and configured by customers as needed. (Required)
    • Sign-in page should have a Sign in with Microsoft button and follow the branding guidelines. (Recommended).
    • Application should be publisher verified by using your MPN ID. Please follow the guidance Microsoft publishes. (Required)
    • Establish an engineering and support point of contact to support customers post gallery onboarding (Required)
    • Document your OIDC OAuth SSO configuration publicly (Required)
    • Meet the various compliance requirements for listing your application in different clouds like Public, USGov, China, Germany, France, Singapore etc. This is only required if you plan to publish your application in those clouds. (Required)
    • Microsoft Entra App Gallery doesn't onboard public client applications.

    Checklist for SCIM provisioning apps

    Review this checklist before you submit a request to list your SCIM provisioning application in the Microsoft Entra application gallery.

    SCIM API requirements

    • Support a SCIM 2.0 user and group endpoint (Only User Provisioning is required but User and Group Provisioning both are recommended).
    • Support at least 25 requests per second per tenant to ensure that users and groups are provisioned and deprovisioned without delay (Required).
    • Validate and test your SCIM User and/or Group Provisioning integration with non-gallery application template (Required).
    • Validate your Client Credentials authentication or any other supported authentication using non-gallery application (Required).
    • Support either soft delete or hard delete of users. Either one is needed, both are also supported (Required).
    • On querying a nonexistent user your SCIM server shouldn't return bad request, rather success with 0 results (Required).
    • Support Schema Discovery feature on your SCIM endpoint (Required).
    • Support updating multiple group memberships with a single PATCH (Recommended).
    • Support for SCIM bulk APIs, which can improve the connector performance (Recommended).

    SCIM authentication requirements

    Support OAuth 2.0 Client Credentials flow in SCIM Provisioning authentication (Required). We aren't onboarding any SCIM Provisioning application with long lived bearer tokens, basic authentication, or Code Auth Grant flow.

    • OAuth 2.0 Client Credentials Flow (Required)

      • Provide customers with a client_id, client_secret, auth token endpoint, and SCIM endpoint so that customers can configure this information in Microsoft Entra ID App.
      • Client Secret should expire between one year to three years, and then the access token can't be retrieved with expired credentials (Required).
      • Provide the ability to rotate client secrets regularly. ISVs should enable smooth rotation by allowing multiple active secrets and supporting deletion of old secrets. Alternatively, customers can create new client_id and client_secret.
      • Access Token should be only valid for 60 minutes (1 hour) to 6 hours but not less than 60 minutes (Required)
    • Workload Identity Federation (Recommended)

      Workload Identity Federation (WIF) is a newer authentication method that lets the Microsoft Entra provisioning service authenticate to your SCIM endpoint without storing any long-lived secrets. Instead of a shared client secret or bearer token, Entra ID presents a signed JWT assertion to your token endpoint using the OAuth 2.0 JWT bearer profile defined in RFC 7523, and receives a short-lived access token in return. Because trust is established through cryptographic verification of Entra-issued tokens rather than stored credentials, there are no secrets to rotate and less risk of credential leakage. To support WIF, your token endpoint must validate the Entra-issued JWT against Microsoft's published JWKS and issue access tokens scoped to your SCIM endpoint. For the full configuration flow, token claims, and ISV implementation requirements, see the Workload Identity Federation for SCIM provisioning guide.

    ISV requirements for SCIM apps

    • Establish an engineering and support point of contact to support customers post Microsoft Entra App Gallery onboarding and for Microsoft to reach out in future (Required)
    • Document your SCIM endpoint publicly and share the link (Required)
    • Deploy your SCIM Provisioning to at least 100 mutual customers using the Microsoft Entra non-gallery approach to qualify for the Microsoft Entra App Gallery listing.
    • If applicable, meet the various compliance requirements for listing your application in different clouds like USGov, China, Germany, France, Singapore, etc. (Required)

    Known limitations for SCIM-based user provisioning

    See Known issues for app provisioning for the full list of known limitations in the Microsoft Entra SCIM outbound provisioning.

    Create and publish documentationShared prerequisites

    Before you submit youran application, preparecomplete these prerequisites:

    • Read and agree to the documentation yourMicrosoft Entra App Gallery terms and conditions.
    • Prepare a production-ready application that customers can access.
    • Establish engineering and Microsoft need. The following sections describe what to publish on your own sitesupport contacts for onboarding and what to provide to Microsoft.

      Provide apppost-onboarding support.

    • Prepare public customer documentation for each capability that you plan to publish.
    • Create a test tenant and test accounts. You can join the Microsoft 365 Developer Program to get a renewable development subscription with Microsoft Entra features.
    • Associate your siteorganization with the Microsoft AI Cloud Partner Program.

    Prepare customer documentation

    Ease of adoption is an important factor for those people that make decisions about enterprise software. Documentation that's clearClear documentation helps customers configure and easy to follow helpssupport your users adopt technology and it reduces support costs.

    Create documentation that includesintegration. Include the following information at minimum:information:

    • An introduction to your SSO functionality
      • Protocols
      • VersionSupported capabilities, protocols, versions, and SKU
      • List of supported identity providers with documentation links
      SKUs.
    • Licensing information for your applicationrequirements.
    • Role-based access control for configuring SSORoles required to configure the integration.
    • SSO Configuration Steps
      • UI configuration elements for SAML (Simple Assertion Markup Language) with expected values from the provider
      • Service provider information to be passed to identity providers
    • If you use OIDC/OAuth, a list of permissions required for consent, with business justifications. Use the least privileged permissions for your scenario.
    • Testing steps for pilot usersand testing steps.
    • Troubleshooting information, including error codes and messagesmessages.
    • Support mechanisms for users
    • Details about your SCIM endpoint, including supported resources and attributesoptions.

    App documentation on

    The SSO and user provisioning requirement articles describe the Microsoft site

    When your SAML application is addedcapability-specific information to the gallery, documentation is created that explains the step-by-step process. For an example, see Tutorials for integrating SaaS applications with Microsoft Entra ID. This documentation is created based on your submission to the gallery. You can easily update the documentation if you make changes to your application by using your GitHub account.

    For Open ID Connect applications, there's no application specific documentation. We have only the generic tutorial for all the OpenID Connect applications.include.

    Publish your application

    After you've tested that your application works with Microsoft Entra ID,meets the applicable requirements and passes validation, see Publish your app to Microsoft Entra App Gallery.

    Join the Microsoft partner network

    The Microsoft Partner Network provides instant access to exclusive programs, tools, connections, and resources. To join the network and create your go-to-market plan, see Reach commercial customers.

    Next steps

    Daily Entra.News

    Get daily email updates

    Get a concise summary of the latest Microsoft Entra updates delivered straight to your inbox.

    Loading the secure signup form…