Skip to content

Commit e9fbfcc

Browse files
authored
chore(docs): include custom roles examples and mention of password reset (coder#15294)
Added example custom roles for admin inspiration, mention of headless authentication use case, and user-activated password reset.
1 parent 85ff8e0 commit e9fbfcc

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/admin/users/groups-roles.md

+19
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,25 @@ in the dashboard under **Organizations** -> **My Organization** -> **Roles**.
4242
4343
![Custom roles](../../images/admin/users/roles/custom-roles.PNG)
4444

45+
### Example roles
46+
47+
- The `Banking Compliance Auditor` custom role cannot create workspaces, but can
48+
read template source code and view audit logs
49+
- The `Organization Lead` role can access user workspaces for troubleshooting
50+
purposes, but cannot edit templates
51+
- The `Platform Member` role cannot edit or create workspaces as they are
52+
created via a third-party system
53+
54+
Custom roles can also be applied to
55+
[headless user accounts](./headless-auth.md):
56+
57+
- A `Health Check` role can view deployment status but cannot create workspaces,
58+
manage templates, or view users
59+
- A `CI` role can update manage templates but cannot create workspaces or view
60+
users
61+
62+
### Creating custom roles
63+
4564
Clicking "Create custom role" opens a UI to select the desired permissions for a
4665
given persona.
4766

docs/admin/users/index.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,12 @@ Confirm the user activation by typing **yes** and pressing **enter**.
143143

144144
## Reset a password
145145

146-
To reset a user's via the web UI:
146+
As of 2.17.0, users can reset their password independently on the login screen
147+
by clicking "Forgot Password." This feature requires
148+
[email notifications](../monitoring/notifications/index.md#smtp-email) to be
149+
configured on the deployment.
150+
151+
To reset a user's password as an administrator via the web UI:
147152

148153
1. Go to **Users**.
149154
2. Find the user whose password you want to reset, click the vertical ellipsis

0 commit comments

Comments
 (0)