Skip to content

Commit 05d0b0a

Browse files
committed
update docs
1 parent 82dc649 commit 05d0b0a

1 file changed

Lines changed: 35 additions & 24 deletions

File tree

apps/docs/content/docs/en/platform/permissions.mdx

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,36 @@
11
---
22
title: Roles and permissions
3-
description: Organization roles, workspace permission levels, and who can do what.
3+
description: How organization, workspace, and credential roles work together — and how they inherit.
44
pageType: reference
55
---
66

77
import { Callout } from 'fumadocs-ui/components/callout'
88
import { Video } from '@/components/ui/video'
99

10-
Access in Sim has two layers: **organization roles** (Owner, Admin, Member) govern the organization itself, and **workspace permissions** (Read, Write, Admin) govern what each member can do inside a workspace.
10+
Access in Sim is organized into three nested levels — your **organization**, the **workspaces** inside it, and the **credentials** (connected accounts and secrets) inside those. Each level has its own roles, and roles **inherit downward**: an admin at one level is automatically an admin at the level below. Inheritance only ever *adds* access — it never takes access away from someone who already has it.
11+
12+
## How roles inherit
13+
14+
Each level has its own set of roles:
15+
16+
| Level | Roles |
17+
|-------|-------|
18+
| **Organization** | Owner, Admin, Member |
19+
| **Workspace** | Read, Write, Admin |
20+
| **Credentials** (shared connections and secrets) | Member, Admin |
21+
22+
Higher roles flow down automatically:
23+
24+
- An organization **Owner or Admin** is automatically an **Admin of every workspace** in the organization — no per-workspace invite required.
25+
- A workspace **Admin** is automatically an **Admin of every shared credential** in that workspace — OAuth connections, service accounts, and workspace secrets.
26+
27+
Put together, an organization Owner or Admin can administer every workspace and every shared credential in the organization, top to bottom.
28+
29+
Inherited roles are **automatic and locked**. In member lists they show greyed out with a short tooltip saying where the role comes from (for example, *"Organization admins are automatically workspace admins"*), and they can't be lowered there — you change them at the level they come from.
30+
31+
<Callout type="info">
32+
**Personal secrets are the one exception.** A user's personal environment variables stay private to them and are never shared or inherited — not by workspace Admins, not by organization Owners or Admins, not by anyone.
33+
</Callout>
1134

1235
## Workspaces and Organizations
1336

@@ -96,32 +119,20 @@ Here's a detailed breakdown of what users can do with each permission level:
96119
- Invite new users to the workspace with any permission level
97120
- Remove users from the workspace
98121
- Manage workspace settings and integrations
99-
- Configure external tool connections
122+
- Administer every shared credential in the workspace (OAuth connections, service accounts, and workspace secrets)
100123
- Delete workflows created by other users
124+
- Delete the workspace
101125

102126
**What they cannot do:**
103-
- Delete the workspace (only the workspace owner can do this)
104-
- Remove the workspace owner from the workspace
127+
- Change a role that's inherited from a higher level — an organization admin's workspace role, or the owner's, is locked and managed where it comes from
105128

106129
---
107130

108-
## Workspace Owner vs Admin
109-
110-
Every workspace has one **Owner** (the person who created it) plus any number of **Admins**.
131+
## Workspace Owner
111132

112-
### Workspace Owner
113-
- Has all Admin permissions
114-
- Can delete the workspace
115-
- Cannot be removed from the workspace
116-
- Can transfer ownership to another user
133+
Every workspace has one **Owner** — usually the person who created it. The Owner is simply an Admin whose role is fixed: in the member list it shows as a locked **Admin** (tooltip *"Workspace owner"*), so it can't be lowered. An Owner has no abilities a regular Admin lacks.
117134

118-
### Workspace Admin
119-
- Can do everything except delete the workspace or remove the owner
120-
- Can be removed from the workspace by the owner or other admins
121-
122-
<Callout type="info">
123-
For shared (organization) workspaces, the organization's Owner and Admins are full Admins of every workspace in the organization, even without an explicit per-workspace invite. They automatically see every organization workspace, have complete read, write, and management access, and their workspace role is fixed — it shows greyed out in the member list with a tooltip and cannot be changed.
124-
</Callout>
135+
Any Admin — whether invited directly or an admin by way of their organization role — can manage members and settings and delete the workspace. On a shared workspace an Admin can also remove the Owner; ownership then passes to the organization's owner, so the workspace always has one. (The organization's owner is the one account that can't be removed this way — they're the final fallback.) On your personal workspace you are the Owner and can't be removed.
125136

126137
---
127138

@@ -146,7 +157,7 @@ Every workspace has one **Owner** (the person who created it) plus any number of
146157
Users can create two types of environment variables:
147158

148159
### Personal Environment Variables
149-
- Only visible to the individual user
160+
- Only visible to the individual user, and never shared or inherited — not even by workspace or organization admins
150161
- Available in all workflows they run
151162
- Managed in **Settings**, then go to **Secrets**
152163

@@ -155,7 +166,7 @@ Users can create two types of environment variables:
155166
- **Write**: add new variables, and edit or delete ones you created
156167
- **Admin**: add, edit, delete, and view the values of any workspace variable
157168
- Workspace variables are a kind of workspace credential, so they follow the [Credential Access](#credential-access) rules below — workspace Admins are admins of all of them
158-
- Available to all workspace members; if a personal variable has the same name, the personal one takes priority
169+
- Available to all workspace members. If a workspace variable and a personal variable share the same name, the **workspace** value wins when a workflow runs
159170

160171
---
161172

@@ -212,8 +223,8 @@ import { FAQ } from '@/components/ui/faq'
212223
{ question: "What is the difference between organization roles and workspace permissions?", answer: "Organization roles (Owner, Admin, or Member) control who can manage the organization itself, including inviting people, creating shared workspaces, and handling billing. Workspace permissions (Read, Write, Admin) control what a user can do within a specific workspace, such as viewing, editing, or managing workflows. Internal members need both an organization role and a workspace permission to work within a shared workspace. External workspace members do not have an organization role in your org; they only have workspace-level access." },
213224
{ question: "What happens to my shared workspaces if I cancel or downgrade my Team plan?", answer: "Existing shared workspaces remain accessible to current members, but new invitations are disabled until you upgrade back to a Team or Enterprise plan. No workspaces or members are deleted — the organization is simply dormant until billing is re-enabled." },
214225
{ question: "Can I restrict which integrations or model providers a team member can use?", answer: "Yes, on Enterprise-entitled organizations. Any organization owner or admin can create permission groups with fine-grained controls, including restricting allowed integrations and allowed model providers to specific lists. You can also disable access to MCP tools, custom tools, skills, and various platform features like the knowledge base, API keys, or Copilot on a per-group basis. Permission groups are scoped to the organization and can govern either all workspaces or a specific subset — a user can belong to multiple groups but is governed by exactly one group in any given workspace." },
215-
{ question: "What happens when a personal environment variable has the same name as a workspace variable?", answer: "The personal environment variable takes priority. When a workflow runs, if both a personal and workspace variable share the same name, the personal value is used. This allows individual users to override shared workspace configuration when needed." },
216-
{ question: "Can an Admin remove the workspace owner?", answer: "No. The workspace owner cannot be removed from the workspace by anyone. Only the workspace owner can delete the workspace or transfer ownership to another user. Admins can do everything else, including inviting and removing other users and managing workspace settings." },
226+
{ question: "What happens when a personal environment variable has the same name as a workspace variable?", answer: "The workspace variable wins. When a workflow runs, the resolver checks workspace variables first and falls back to a personal variable only when no workspace variable shares that name. This keeps shared, team-managed values authoritative in production workflows." },
227+
{ question: "Can an Admin remove the workspace owner?", answer: "On a shared (organization) workspace, yes — any Admin can remove the workspace Owner, and ownership passes to the organization's owner so the workspace always has one. The organization's owner is the single account that can't be removed this way, since they're the final fallback. On your personal workspace you are the Owner and can't remove yourself. The Owner is not a higher permission tier than Admin: every Admin — including those who inherit the role from their organization — can manage members and settings and delete the workspace." },
217228
{ question: "Who can manage a workspace's credentials and secrets?", answer: "Workspace Admins are automatically Credential Admins of the workspace's shared credentials — OAuth connections, service accounts, and workspace environment variables — so they can use, edit, delete, and share them, and run workflows that rely on them. Organization Owners and Admins get this too because they are workspace Admins everywhere. Read and Write members get use-only access to shared credentials unless they are explicitly made a Credential Admin. Personal environment variables are never shared; they stay private to their owner." },
218229
{ question: "What are permission groups and how do they work?", answer: "Permission groups are an Enterprise access control feature that lets organization owners and admins define granular restrictions beyond the standard Read/Write/Admin roles. Groups are scoped to the organization and can govern either all workspaces or a specific subset. A user can belong to multiple groups, but at most one governs them in any given workspace: a workspace-specific group takes precedence over an all-workspaces group, which takes precedence over the organization's default group. A permission group can hide UI sections (like trace spans, knowledge base, API keys, or deployment options), disable features (MCP tools, custom tools, skills, invitations), and restrict which integrations and model providers its members can access. Members are assigned manually, and an organization can designate one group as the default (always all-workspaces) that governs everyone not explicitly assigned — including external workspace members. Restrictions are enforced based on the organization that owns the workflow's workspace, not on which workspace you're currently viewing." },
219230
{ question: "How should I set up permissions for a new team member?", answer: "Start with the lowest permission level they need. Invite teammates to the organization as Members, then add them to the relevant workspace with Read permission if they only need visibility, Write if they need to create and run workflows, or Admin if they need to manage the workspace and its users. For clients, partners, or users who already belong to another Sim organization, use external workspace access so they can collaborate without joining your organization or consuming a seat." },

0 commit comments

Comments
 (0)