Skip to content

Commit 2573838

Browse files
authored
chore(docs): add documentation on custom roles (coder#15280)
These docs were overwritten in the restructure merge.
1 parent bbd2dd8 commit 2573838

File tree

4 files changed

+24
-0
lines changed

4 files changed

+24
-0
lines changed

docs/admin/users/groups-roles.md

+24
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,30 @@ Roles determine which actions users can take within the platform.
3131
A user may have one or more roles. All users have an implicit Member role that
3232
may use personal workspaces.
3333

34+
## Custom Roles (Premium) (Beta)
35+
36+
Starting in v2.16.0, Premium Coder deployments can configure custom roles on the
37+
[Organization](./organizations.md) level. You can create and assign custom roles
38+
in the dashboard under **Organizations** -> **My Organization** -> **Roles**.
39+
40+
> Note: This requires a Premium license.
41+
> [Contact your account team](https://coder.com/contact) for more details.
42+
43+
![Custom roles](../../images/admin/users/roles/custom-roles.PNG)
44+
45+
Clicking "Create custom role" opens a UI to select the desired permissions for a
46+
given persona.
47+
48+
![Creating a custom role](../../images/admin/users/roles/creating-custom-role.PNG)
49+
50+
From there, you can assign the custom role to any user in the organization under
51+
the **Users** settings in the dashboard.
52+
53+
![Assigning a custom role](../../images/admin/users/roles/assigning-custom-role.PNG)
54+
55+
Note that these permissions only apply to the scope of an
56+
[organization](./organizations.md), not across the deployment.
57+
3458
### Security notes
3559

3660
A malicious Template Admin could write a template that executes commands on the
Loading
Loading
105 KB
Loading

0 commit comments

Comments
 (0)