Skip to main content

Auto install flow

Auto mode is the lowest-friction way to distribute your app. You create the application once as a Public app, and any organization can install it themselves from the marketplace and start using it right away. There is no request to approve and no invitation to send—the installation is active the moment it's created.

Example​

Let's follow one real installation end to end.

The players

  • PixelInnovations — the owner. It publishes an app called ACME INDUSTRIES as a Public, Auto-approved app.
  • HopeBridge Foundation — the consumer. It installs ACME INDUSTRIES from the marketplace to use its KYC scopes.

The flow at a glance​

Owner · PixelInnovationsMarketplaceConsumer · HopeBridgeCreate app (Public + Auto)1Listed in the Marketplace2Install & grant scopes3Status ACTIVE4Obtain token for consumer5Either side can Uninstall or Revoke anytime

Step by step​

1PixelInnovations creates and publishes the app

PixelInnovations sets the app to Public visibility and Auto Approved mode, then creates it.

2The app appears in the Marketplace

HopeBridge Foundation finds the published app under Public Apps in the marketplace and clicks Install.

3HopeBridge Foundation installs it and grants scopes

HopeBridge Foundation reviews the requested scopes and confirms. The install activates immediately.

Because Mode = Auto, the app is usable immediately: ACME INDUSTRIES can now obtain access tokens for HopeBridge Foundation, limited to the scopes it was granted. There is no PENDING state.

After the app is active​

Once the app is ACTIVE, either side can end it at any time.

Uninstall

Done by the consumer — HopeBridge Foundation

Removes the app from their organization. The installation becomes UNINSTALLED and the app can no longer obtain tokens for that org.

Revoke

Done by the owner — PixelInnovations

Ends the installation from the app's side. The installation becomes REVOKED and HopeBridge Foundation loses access.

Related