Skip to content

Commit 3de622d

Browse files
authored
docs: Add actions to Access Control (#9315)
* Edits * docs: Add actions to Access Control * Fix
1 parent 1b9c439 commit 3de622d

File tree

1 file changed

+94
-17
lines changed

1 file changed

+94
-17
lines changed

docs/pages/product/workspace/access-control.mdx

+94-17
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
1-
---
2-
redirect_from:
3-
- /cloud/access-control/
4-
---
5-
61
# Access Control
72

8-
As an account administrator, you can define roles with specific permissions for
9-
resources and apply those roles to users within the account.
3+
As a Cube Cloud account administrator, you can define roles with specific permissions
4+
for Cube Cloud resources and apply those roles to users within the account.
105

116
<SuccessBox>
127

@@ -15,25 +10,59 @@ Access control is available in Cube Cloud on
1510

1611
</SuccessBox>
1712

18-
## List all roles
13+
You can [manage accounts](#managing-accounts) as an account administrator,
14+
[manage roles](#managing-roles), [assign them](#assigning-roles-to-users) to users,
15+
and associate [supported actions](#actions) with those roles.
16+
17+
## Managing accounts
18+
19+
Account administrators have ultimate control over the Cube Cloud account, including
20+
[managing roles](#managing-roles) and assigning them to users.
21+
22+
You can see which users are account administrators on the <Btn>Members</Btn> tab of the
23+
<Btn>Team & Security</Btn> page in your Cube Cloud. Account administrators have the
24+
<Btn>Admin</Btn> toggle enabled next to their name.
25+
26+
## Managing roles
27+
28+
In Cube Cloud, users are not assigned permissions directly. Instead, they are assigned
29+
_roles_ that are associated with _policies_. Each policy define what _actions_ they can
30+
perform and on what _resources_ they can perform those actions. This approach makes it
31+
easier to manage permissions at scale.
1932

20-
To see a list of roles in your account, first go to the Team settings page by
21-
clicking on your avatar in the top right corner, then clicking on the "Team"
22-
button.
33+
Each role can be associated with one or more of the following policies:
2334

24-
On the Team settings page, click the "Roles" tab to see all the roles in your
25-
account:
35+
| Policy | Description |
36+
| --- | --- |
37+
| `Global` | Controls account-level functionality, e.g., as Billing. |
38+
| `Deployment` | Controls deployment-level functionality, e.g., as Playground. |
39+
| `Report` | Controls access to specific reports in Saved Reports. |
40+
| `ReportFolder` | Controls access to specific folders in Saved Reports. |
41+
42+
Each policy can apply to _all resources_ or _specific resources_. For example, a policy
43+
could apply to all deployments or only to a specific deployment.
44+
45+
Also, each policy can have _all actions_ or only _specific actions_ associated with it.
46+
For example, a policy could allow a user to view, create, or delete one or more
47+
deployments if it's associated with those specific actions.
48+
49+
See [actions reference](#actions) for a list of available actions.
50+
51+
### Browsing roles
52+
53+
To see a list of roles, go to the <Btn>Team & Security</Btn> page in your Cube Cloud
54+
account, then navigate to the <Btn>Roles</Btn> tab:
2655

2756
<Screenshot
2857
alt="Cube Cloud Team Roles tab"
2958
src="https://ucarecdn.com/476cb30f-4939-41a8-a399-53d4f8a47dee/"
3059
/>
3160

32-
## Create a role
61+
### Creating a role
3362

34-
To create a new role, click the "Add Role" button. Enter a name and optional
35-
description for the role, then click "Add Policy" and select either "Deployment"
36-
or "Global" for this policy's scope.
63+
To create a new role, click the <Btn>Add Role</Btn> button. Enter a name and an optional
64+
description for the role, then click <Btn>Add Policy</Btn> and select either <Btn>Deployment</Btn>
65+
or <Btn>Global</Btn> for this policy's scope.
3766

3867
Deployment policies apply to deployment-level functionality, such as the
3968
Playground and Data Model editor. Global policies apply to account-level
@@ -63,3 +92,51 @@ Existing users' roles can be modified from the "Members" tab on the Team page:
6392
alt="Cube Cloud Team Roles tab"
6493
src="https://ucarecdn.com/a72cad30-487b-484a-b557-0f0e157c89b1/"
6594
/>
95+
96+
## Actions
97+
98+
Policies can have the following actions associated with them.
99+
100+
Actions for the `Global` policy:
101+
102+
| Action | Description |
103+
| --- | --- |
104+
| `Alerts Access`<br/>`Alerts Create`<br/>`Alerts Edit`<br/>`Alerts Delete` | View, create, edit, and delete [budgets][ref-budgets]. |
105+
| `Billing Access` | Access the billing data of the Cube Cloud account. |
106+
| `Deployment Manage` | Create and delete deployments in the Cube Cloud account. |
107+
108+
Actions for the `Deployment` policy:
109+
110+
| Action | Description |
111+
| --- | --- |
112+
| `Deployment View`<br/>`Deployment Edit` | Access the deployment, change its settings. |
113+
| `Playground Access` | Use [Playground][ref-playground]. |
114+
| `Data Model View` | View the source code in the [data model][ref-data-model] editor, use [Visual Model][ref-visual-model]. |
115+
| `Data Model Edit (all branches)`<br/>`Data Model Edit (dev branches only)` | Use the [development mode][ref-dev-mode], edit the data model, perform Git operations (e.g., commit, pull, push). |
116+
| `Queries & Metrics Access` | Use [Query History][ref-query-history] and [Performance Insights][ref-perf-insights]. |
117+
| `SQL Runner Access` | Use [SQL Runner][ref-sql-runner]. |
118+
| `Data Assets Access` | Use [Semantic Catalog][ref-semantic-catalog] and [AI Assistant][ref-ai-assistant]. |
119+
120+
Actions for the `Report` policy:
121+
122+
| Action | Description |
123+
| --- | --- |
124+
| `Report Read`<br/>`Report Manage` | View and create/delete reports. |
125+
126+
Actions for the `ReportFolder` policy:
127+
128+
| Action | Description |
129+
| --- | --- |
130+
| `Report Read`<br/>`Report Manage` | View and create/delete report folders. |
131+
132+
133+
[ref-budgets]: /product/workspace/budgets
134+
[ref-playground]: /product/workspace/playground
135+
[ref-data-model]: /product/workspace/data-model
136+
[ref-visual-model]: /product/workspace/visual-model
137+
[ref-dev-mode]: /product/workspace/dev-mode
138+
[ref-query-history]: /product/workspace/query-history
139+
[ref-perf-insights]: /product/workspace/performance
140+
[ref-sql-runner]: /product/workspace/sql-runner
141+
[ref-semantic-catalog]: /product/workspace/semantic-catalog
142+
[ref-ai-assistant]: /product/workspace/ai-assistant

0 commit comments

Comments
 (0)