February 2024

App and Solution Onboarding and Gating Updates

6min

Overview

We have added several new capabilities to App and Solution Onboarding APIs, enabling developers to onboard their apps and solutions to production-type tenants faster. In addition, we have introduced necessary gatings to prevent human-errors such as onboarding of an app or solution in development state to production-type tenants.

Summary of updates

  • Developers can now use the updated onboarding APIs to onboard their apps and solutions to production type (customer facing) tenants. Developers can choose to onboard to a single tenant or list of tenants or to all tenants within a stack.
  • Developers can also onboard their apps or solutions to all tenants in a stack by using a single API call, reducing the time required by developers for onboarding.
  • App and solution onboarding now automatically updates the subscriptions to use latest version, eliminating the need to call a separate subscription API call after the onboarding.
  • The stackCredentialOverwrite attribute in the app and solution onboarding API enables the developers the use of production credentials while onboarding to apps or solutions to development/staging type tenants.

The new gating policies ensure that only fully validated apps and solutions get onboarded to production tenant environments, preventing issues for end users. Updates include:

  • State-based Gating: Apps and solutions must be in a LIVE state to be able to onboarded to production tenants. Additionally, solutions can only go LIVE only if all apps within them are LIVE.
  • Role-based Gating: Only product admins can publish apps/solutions LIVE. Additionally, only developer admins and product admins can onboard apps and solutions to production type tenants.
  • Ownership-based Gating: Only app developers from the organization that own the app can upload AAA permission files within a tenant, this is done to prevent any accidental overwriting of incompatible permissions files.