Skip to main content
Returns the install token, the signed-in teammate, the workspace id, the granted scopes and can(scope).

Returns

organizationId

scopes

token

The install token to send to your own server as a bearer token.

user

user.id

user.role

can()

Whether the install granted the scope.

Parameters

scope
| "ui:render" | "projects:read" | "analytics:read" | "store.metadata:read" | "reviews:read" | "crashes:read" | "revenue:read" | "metrics:write" | "alerts:write" | "insights:write" | "ai:tools" | "ai:actions" | "store.metadata:write" | "autopilot:trigger" | "work:create" | "work:sync" | "storage:write" | "messaging:send" | "ai:skills"

Returns

boolean

Remarks

Re-renders the component when the host rotates the install token, and when the signed-in teammate’s role arrives after the mount. scopes and can report the grant the mount was built with. Throws TAP_OUTSIDE_HOST outside a mount.

Example