From 25738388d55ed3bfc38495752a4ea044a0e3a75c Mon Sep 17 00:00:00 2001 From: Stephen Kirby <58410745+stirby@users.noreply.github.com> Date: Tue, 29 Oct 2024 20:58:26 -0500 Subject: [PATCH] chore(docs): add documentation on custom roles (#15280) These docs were overwritten in the restructure merge. --- docs/admin/users/groups-roles.md | 24 ++++++++++++++++++ .../users/roles/assigning-custom-role.PNG | Bin 0 -> 64037 bytes .../users/roles/creating-custom-role.PNG | Bin 0 -> 84273 bytes .../images/admin/users/roles/custom-roles.PNG | Bin 0 -> 107693 bytes 4 files changed, 24 insertions(+) create mode 100644 docs/images/admin/users/roles/assigning-custom-role.PNG create mode 100644 docs/images/admin/users/roles/creating-custom-role.PNG create mode 100644 docs/images/admin/users/roles/custom-roles.PNG diff --git a/docs/admin/users/groups-roles.md b/docs/admin/users/groups-roles.md index 77dd35bf9d..17c0fc8b5b 100644 --- a/docs/admin/users/groups-roles.md +++ b/docs/admin/users/groups-roles.md @@ -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. + + + +Clicking "Create custom role" opens a UI to select the desired permissions for a +given persona. + + + +From there, you can assign the custom role to any user in the organization under +the **Users** settings in the dashboard. + + + +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 diff --git a/docs/images/admin/users/roles/assigning-custom-role.PNG b/docs/images/admin/users/roles/assigning-custom-role.PNG new file mode 100644 index 0000000000000000000000000000000000000000..271f1bcae7781f353c1ab2db101cd508655787c0 GIT binary patch literal 64037 zcmeFYXH=8X*Dr`v6#*5c7ZC-KDpf#=A|NOry-5=g3B80CiilvLi8LvpN(m+OP5?ov z5^5446p<20=#T^m
?ALhf{HM7=C*2>D0^PIZ(IeY(hIUk?vYBF5pxJW@k
z!Jzfzu>l1Ibqoas<;Q
ziR`gPsXzG2Ke%Fgz?68Z!{ehFTVht2G#oQ5!joD+_SQht`{yk$#;W#~CFE3EnS#`o
zCY0VXcm-nkZ`VuXvE?{W+y|BmhrB6(19U)A3@|EXMO~$P+(LW3ZsFiySHE`PNI>(B
zrsg3abeQh+Lz;SXfz$
*r{t~5
zu!Akj9n%FQ$@)Dl=306+)pKWMbZUN6zx+q3i%DuvyPvFY$cHck$-$pUYBRGr7-#5X
zjjKP`7G7!O`=Yeake0WUth-b*Dk^JY-!fk8SvaX+;2jiO?i?Y*%#~FlR|k96(~X^ZF;*D@q;D$FYDt0V<&