chore(docs): add documentation on custom roles (#15280)

These docs were overwritten in the restructure merge.
This commit is contained in:
Stephen Kirby
2024-10-29 20:58:26 -05:00
committed by GitHub
parent bbd2dd80e2
commit 25738388d5
4 changed files with 24 additions and 0 deletions

View File

@ -31,6 +31,30 @@ Roles determine which actions users can take within the platform.
A user may have one or more roles. All users have an implicit Member role that
may use personal workspaces.
## Custom Roles (Premium) (Beta)
Starting in v2.16.0, Premium Coder deployments can configure custom roles on the
[Organization](./organizations.md) level. You can create and assign custom roles
in the dashboard under **Organizations** -> **My Organization** -> **Roles**.
> Note: This requires a Premium license.
> [Contact your account team](https://coder.com/contact) for more details.
![Custom roles](../../images/admin/users/roles/custom-roles.PNG)
Clicking "Create custom role" opens a UI to select the desired permissions for a
given persona.
![Creating a custom role](../../images/admin/users/roles/creating-custom-role.PNG)
From there, you can assign the custom role to any user in the organization under
the **Users** settings in the dashboard.
![Assigning a custom role](../../images/admin/users/roles/assigning-custom-role.PNG)
Note that these permissions only apply to the scope of an
[organization](./organizations.md), not across the deployment.
### Security notes
A malicious Template Admin could write a template that executes commands on the