Skip to main content

Register your app

Once your app is deployed and can receive authenticated context in the iframe, register it so Atlan can load it in the product. This page guides you through what to provide and how to share it with your Atlan admin or Atlan support, who apply the tenant configuration. For the full schema, field reference, and conditional rendering rules, see App registration.

Prerequisites​

Before you begin, make sure you have:

  • A deployed app at a public HTTPS URL (for example, https://app.company.com).
  • Authentication configured so your app receives user context when loaded in the iframe. If not, see Embed your app.

Provide registration details​

Use these steps to prepare and share the details your admin or support needs to register your app.

  1. Choose an app ID and display name. App ID is a short identifier you define for the app. Atlan uses it in the URL /external/{app-id}. Use lowercase letters, numbers, and hyphens (for example, data-quality-dashboard). Display name is the label shown in the Atlan UI (for example, in the sidebar or on the asset tab).

  2. Provide iframe_url and allowed_origins. iframe_url is the HTTPS URL Atlan loads in the iframe. allowed_origins is the list of app origins allowed for postMessage. Use an origin, not a URL path. For example, use https://app.company.com (not https://app.company.com/embed).

  3. Choose where the app appears using render_at. Use nav-tab so the app appears in the navigation sidebar (users open it at /external/{app-id}), asset-profile-tab so it appears as a tab on asset profile pages, or both. For conditional rules (for example, by asset type or route), see App registration.

Share the details with your Atlan admin or Atlan support so they can update the tenant configuration.

Example: If you want to register an app that appears only in the sidebar, you can share a configuration like this:

{
  "data-quality-dashboard": {
    "display_name": "Data Quality Dashboard",
    "iframe_url": "https://dq-dashboard.your-company.com",
    "allowed_origins": ["https://dq-dashboard.your-company.com"],
    "render_at": [{ "slot": "nav-tab" }]
  }
}

Replace the app ID, display_name, iframe_url, and allowed_origins with your values.

Verify it works​

Once the configuration is live, open your app and confirm it renders the expected UI.

  1. Open the app from the navigation sidebar (nav-tab) and confirm the page loads and renders user context. If you use the SDK example from Embed your app, the page renders Hello <username>.

  2. If you configured an asset profile tab (asset-profile-tab), open an asset and select your tab. Atlan includes the asset GUID in context.page.params.id. Use the token in the auth context to fetch asset details from Atlan APIs. For the complete payload (token, user, page), see Auth payload.

Need help?​

If you run into issues while registering or loading your app, see the troubleshooting guide. For configuration or tenant changes, contact Atlan support: Submit a request.

Next steps​