Skip to content

Commit 97ad522

Browse files
authored
docs: add "Manage users" page under Admin → Users & Permissions (cube-js#10626)
Made-with: Cursor
1 parent 78b56af commit 97ad522

3 files changed

Lines changed: 120 additions & 20 deletions

File tree

docs-mintlify/admin/users-and-permissions/index.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
title: Manage users
3+
description: Add users to your Cube Cloud account, assign roles, and control their access.
4+
---
5+
6+
Use the **Admin → Users** page to add people to your Cube Cloud account,
7+
change their roles, and control what they can access.
8+
9+
<Info>
10+
11+
Only users with the Admin role can manage other users.
12+
13+
</Info>
14+
15+
## The user list
16+
17+
The user list displays all users in your account along with their roles
18+
and status. Use the search bar to filter users by name or email.
19+
20+
## Inviting users
21+
22+
To invite a new user:
23+
24+
1. Navigate to **Admin → Users**.
25+
2. Click **Add User**.
26+
3. Enter the user's email address.
27+
4. Select a [role][ref-roles] for the user: Admin, Developer, Explorer, or
28+
Viewer.
29+
5. Optionally, assign one or more [custom roles][ref-custom-roles].
30+
6. Click **Create** to send the invitation.
31+
32+
After the user is created, an invitation link is generated. You can copy the
33+
link and share it with the user. The user must visit the link to set their
34+
password and activate their account.
35+
36+
### Resending invitations
37+
38+
If a user hasn't activated their account, you can resend or copy the
39+
invitation link from the user list.
40+
41+
## Managing individual users
42+
43+
Click on a user in the user list to access their settings page. From here,
44+
you can:
45+
46+
- Update the user's name
47+
- Change their [role][ref-roles] (Admin, Developer, Explorer, or Viewer)
48+
- Assign or remove [custom roles][ref-custom-roles]
49+
- Add the user to [user groups][ref-groups]
50+
- Set [user attribute][ref-attributes] values for data access control
51+
52+
### Changing a user's role
53+
54+
To change a user's role:
55+
56+
1. Navigate to **Admin → Users** and click on the user.
57+
2. Select a new role from the role dropdown.
58+
3. Save the changes.
59+
60+
Alternatively, you can change a user's role directly from the user list
61+
using the role dropdown.
62+
63+
<Info>
64+
65+
Admin roles are billed at the developer rate.
66+
67+
</Info>
68+
69+
## Deactivating and reactivating users
70+
71+
Deactivating a user revokes their access to Cube Cloud without permanently
72+
removing their account. The user's active sessions are terminated immediately.
73+
74+
To deactivate a user:
75+
76+
1. Navigate to **Admin → Users**.
77+
2. Click the actions menu for the user.
78+
3. Select **Deactivate**.
79+
80+
<Warning>
81+
82+
You cannot deactivate yourself or the last active Admin user.
83+
84+
</Warning>
85+
86+
To reactivate a deactivated user, follow the same steps and select
87+
**Activate**. The user can then log in again with their existing credentials.
88+
89+
## Deleting users
90+
91+
Deleting a user permanently removes their account from Cube Cloud.
92+
93+
To delete a user:
94+
95+
1. Navigate to **Admin → Users**.
96+
2. Click the actions menu for the user.
97+
3. Select **Delete**.
98+
99+
<Warning>
100+
101+
You cannot delete your own account. Deleting a user is irreversible.
102+
103+
</Warning>
104+
105+
## Provisioning users via SCIM
106+
107+
If your organization uses an identity provider such as [Okta][ref-okta] or
108+
[Microsoft Entra ID][ref-entra-id], you can automate user provisioning and
109+
deprovisioning through SCIM. See the [SSO & Identity Providers][ref-sso]
110+
documentation for setup instructions.
111+
112+
113+
[ref-roles]: /admin/users-and-permissions/roles-and-permissions
114+
[ref-custom-roles]: /admin/users-and-permissions/custom-roles
115+
[ref-attributes]: /admin/users-and-permissions/user-attributes
116+
[ref-groups]: /admin/users-and-permissions/user-groups
117+
[ref-sso]: /admin/sso
118+
[ref-okta]: /admin/sso/okta/scim
119+
[ref-entra-id]: /admin/sso/microsoft-entra-id/scim

docs-mintlify/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@
205205
{
206206
"group": "Users & Permissions",
207207
"pages": [
208-
"admin/users-and-permissions",
208+
"admin/users-and-permissions/manage-users",
209209
"admin/users-and-permissions/roles-and-permissions",
210210
"admin/users-and-permissions/user-attributes",
211211
"admin/users-and-permissions/user-groups",

0 commit comments

Comments
 (0)