Fetch workspace authority

Overview

useFetchWorkspaceAuthority returns a callable that resolves the signed-in user’s standing on a workspace: { reasons, capabilities, permissions, rank }. Use it to drive UI (show/hide buttons) — a permission check is a one-line .includes() on the result. Sublay never consumes your opaque permissions.

Not visibility-gated. GET /workspaces/:id/authority/me requires a signed-in user and nothing more. It returns 404 only when the workspace does not exist — a signed-in user with no relation to an existing workspace gets 200 with reasons: [] and empty capabilities / permissions, which is exactly the answer a UI gate wants. The trade-off is that the route confirms a workspace exists to any signed-in caller.Its sibling, useFetchWorkspaceMemberStanding, is visibility-gated and 404s on a workspace the caller cannot see, so it never leaks existence. Do not assume the two behave alike.

Usage Example

import { useFetchWorkspaceAuthority } from "@sublay/react-js";

function InviteGate({ workspaceId }: { workspaceId: string }) {
  const fetchWorkspaceAuthority = useFetchWorkspaceAuthority();

  const canInvite = async () => {
    const authority = await fetchWorkspaceAuthority({ workspaceId });
    return authority.capabilities.includes("invite");
  };
}

Parameters

string

required

The workspace UUID.

Returns

WorkspaceAuthority:

Field	Type	Description
`reasons`	`WorkspaceAuthorityReasonDetail[]`	Why the user has standing — structured `{ type, viaWorkspaceId? }` entries (`type` is `"owner"`/`"ancestor-owner"`/`"member"`/`"reach-holder"`).
`capabilities`	`string[]`	The resolved capability set (direct + reach + ownership).
`permissions`	`string[]`	Per-node permissions (may be empty).
`rank`	`number \| null`	Direct-membership rank, or `null`.

WorkspaceAuthorityReasonDetail:

Field	Type	Description
`type`	`"owner" \| "ancestor-owner" \| "member" \| "reach-holder"`	The kind of standing.
`viaWorkspaceId`	`string?`	The ancestor granting it — present on `ancestor-owner` / `reach-holder` only. A user reaching in from several ancestors carries one entry per ancestor.

view is implied by every other capability. Any user with standing resolves with view in capabilities, including a member whose stored capabilities array is empty. A user with no relation at all resolves to reasons: [] and an empty capability set — so capabilities.includes("view") is a reliable “does this user have any standing here” check.

Unlike the member-standing read, this hook is inherently a self read, so capabilities / permissions / rank are never fenced here.

Read Authority API

Overview

Auth Hooks

Current User

User Profiles

Entities

Entity Lists

Spaces

Spaces — Rules

Space Lists

Workspaces

Events

Comments

Reactions

Follows

Connections

Blocks

Collections

App Notifications

Push Notifications

Chat — Conversations

Chat — Messages

Chat — Core

Search

Reports

Storage

Crypto

Project

Custom Tables

Overview

Usage Example

Parameters

Returns

​Overview

​Usage Example

​Parameters

​Returns

​Related

Overview

Usage Example

Parameters

Returns

Related