Skip to content

Commit cb8117c

Browse files
docs: document scope dependencies in custom roles (#988)
* docs: document scope dependencies and role type step in custom roles * docs: replace scope dependencies image with correct screenshot --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent cb851ec commit cb8117c

2 files changed

Lines changed: 21 additions & 3 deletions

File tree

59.5 KB
Loading

references/workspace/custom-roles.mdx

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,16 +89,34 @@ This approach gives you precise control over what users can do in each project w
8989

9090
![create-new-role.png](/images/references/workspace/create-new-role.png)
9191

92+
### Scope dependencies
93+
94+
Many scopes depend on other scopes to work correctly — for example, most project scopes require `view:Project`. When building or editing a role, the role builder shows each scope's dependency status:
95+
96+
- **Green check mark** — all dependencies are met.
97+
- **Orange triangle** — some dependencies are met. The scope will still function, but certain aspects of the permission will not work.
98+
- **Red circle** — none of the dependencies are met.
99+
100+
A summary in the bottom-left of the role builder shows how many selected scopes have all, some, or none of their dependencies met.
101+
102+
![scope-dependencies.png](/images/references/workspace/scope-dependencies.png)
103+
104+
A couple of things worth knowing:
105+
106+
- Selecting a scope automatically selects its required dependencies.
107+
- _Deselecting_ a scope does **not** auto-deselect its dependencies. Many scopes (like `view:Project`) are required by lots of other scopes, so Lightdash leaves them in place to avoid silently breaking other selected scopes.
108+
92109
### Duplicate an Existing Role
93110

94111
If you want to create a role similar to an existing one:
95112

96113
1. Find the role you want to duplicate (system role or custom role)
97114
2. Click the **** menu next to the role
98115
3. Select **Duplicate Role**
99-
4. Enter a new name for the duplicated role
100-
5. Modify the scopes as needed
101-
6. Click **Save**
116+
4. Select the **role type****Organization** or **Project**. This determines whether the duplicated role will be applied at the organization level or the project level, and which scopes are available. Once selected, the role type cannot be changed.
117+
5. Enter a new name for the duplicated role
118+
6. Modify the scopes as needed
119+
7. Click **Save**
102120

103121
This is particularly useful when you want to create a role similar to a system role but with some modifications.
104122

0 commit comments

Comments
 (0)