Skip to main content
Install an Atlan app for your organization, then decide which workspaces can create and edit content with it. This page is for organization admins; workspace admins can use the last section to turn an app’s authoring on or off in their workspace.

​
Before you begin

  • Install, upgrade, uninstall, and organization availability: You are an organization admin. Workspace Builder or Admin access is not enough.
  • Authoring in one workspace: You are an admin of that workspace.
  • Your organization’s plan includes the app. If it doesn’t, the app shows Plan required and View plans instead of Install.

​
Install an app

1

Open Apps

Select Integrations at the bottom of the left rail, then select Apps. The page lists the apps your team can install, such as Metric Studio and Ontology Studio.
2

Install the app

Select Install on the app’s card, or open the app and select Install in its header. The button reads Installing until the install finishes.Installing again is safe: it retries the install and keeps the original installer and date.
3

Open the app

When the badge reads Installed, open the app and select Open. The app also appears in the left rail for everyone in your organization.
After install, the app is available in every workspace, including workspaces created later. To narrow that, set its organization availability.

​
Choose which workspaces can use it

1

Open Organization availability

Open the installed app from Integrations > Apps and select Organization availability in its header. The same button appears on the app’s row in a workspace’s Apps settings.
2

Choose the workspaces

Leave All workspaces on to include existing and future workspaces. Turn it off to choose workspaces: select the ones you can see, or paste a Workspace ID and select Add.With a selection, only the selected workspaces can author, and new workspaces are excluded. Selections in workspaces you can’t see are kept.
3

Save

Select Save availability. App availability updated confirms the change.
This setting controls where the app can create and run new work. It grants no access to workspace content, and existing reads, history, and exports keep their permissions.

​
Turn authoring off in one workspace

A workspace admin can stop an app from creating new work in their workspace, within what the organization allows.
1

Open the workspace's Apps tab

Open Settings, choose the workspace under Workspaces, and select Apps.
2

Switch authoring off or on

Use the switch on the app’s row. Turning it off asks you to confirm Turn off app authoring?. Select Turn off authoring.People, APIs, and agents then can’t create, edit, publish, or start new work with the app in this workspace. Existing content, history, and exports keep their permissions. You can’t turn authoring on in a workspace the organization’s availability excludes.

​
Uninstall an app

1

Open the app

Open the app from Integrations > Apps.
2

Uninstall

Select More actions for app, then Uninstall app. Read Uninstall app?, then select Uninstall.
The app leaves the left rail for everyone in your organization. Its records are not deleted: they stay readable, and installing the app again finds them.

​
Upgrade an app

The app has no upgrade button. To move an installed app to the version your Atlan deployment currently offers, call POST /registry/v1/apps/{app}/upgrade as an organization admin. Send {"is_pinned": true} to keep the app on that version; omit it or send false to remove the pin. An upgrade changes the recorded version only and does not migrate data.

​
Verify

  • Install: The app’s card shows Installed, and Open opens it.
  • Availability: In a workspace outside the selection, the app’s row in Apps says Your organization has restricted this app in this workspace. Existing content remains available under workspace permissions.
  • Authoring off: The row says Authoring is off in this workspace. Existing content, history and exports remain available under workspace permissions.
  • Uninstall: The app no longer appears in the left rail or in Brain > Apps.

​
Troubleshooting