Skip to content

chore: cherry pick PRs for 2.17 #15339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Nov 1, 2024
Merged

chore: cherry pick PRs for 2.17 #15339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
aa8e262
fix: workspaces query to correctly user username from users table (#1…
Emyrk Oct 31, 2024
d799404
refactor(site): refactor DAU chart to avoid seat consumption focus (#…
BrunoQuaresma Oct 31, 2024
0cd5066
chore(cli): drop 'notification' prefix for configuring email auth (#1…
DanielleMaywood Oct 30, 2024
ced50fc
chore: fix concurrent `CommitQuota` transactions for unrelated users/…
Emyrk Nov 1, 2024
041eb99
feat: add prometheus metric for tracking user statuses (#15281)
coadler Oct 30, 2024
920c275
feat: add audit logs for dormancy events (#15298)
coadler Oct 31, 2024
131cb0d
docs: add new best practice doc to speed up templates and workspaces …
EdwardAngert Nov 1, 2024
7d44613
chore(docs): add documentation on custom roles (#15280)
stirby Oct 30, 2024
bc92a19
chore(docs): include custom roles examples and mention of password re…
stirby Oct 30, 2024
48f7555
chore(docs): add info on new build timings in docs (#15310)
stirby Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore(docs): include custom roles examples and mention of password re… 
…set (#15294)

Added example custom roles for admin inspiration, mention of headless
authentication use case, and user-activated password reset.

(cherry picked from commit e9fbfcc)
  • Loading branch information
@stirby
stirby committed Nov 1, 2024
commit bc92a19a119661c0b3d33111a81135f38a5aa78f
19 changes: 19 additions & 0 deletions docs/admin/users/groups-roles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,25 @@ in the dashboard under **Organizations** -> **My Organization** -> **Roles**.

![Custom roles](../../images/admin/users/roles/custom-roles.PNG)

### Example roles

- The `Banking Compliance Auditor` custom role cannot create workspaces, but can
read template source code and view audit logs
- The `Organization Lead` role can access user workspaces for troubleshooting
purposes, but cannot edit templates
- The `Platform Member` role cannot edit or create workspaces as they are
created via a third-party system

Custom roles can also be applied to
[headless user accounts](./headless-auth.md):

- A `Health Check` role can view deployment status but cannot create workspaces,
manage templates, or view users
- A `CI` role can update manage templates but cannot create workspaces or view
users

### Creating custom roles

Clicking "Create custom role" opens a UI to select the desired permissions for a
given persona.

Expand Down
7 changes: 6 additions & 1 deletion docs/admin/users/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,12 @@ Confirm the user activation by typing **yes** and pressing **enter**.

## Reset a password

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

To reset a user's password as an administrator via the web UI:

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