73b6ef6a73
* basic procedural steps * more questions, more typos * more typos * tweaks * more content, new links * fixed link * tweak * fix things * more fixes * yet more fixes * Apply suggestions from code review Co-authored-by: Dewi Roberts <dewi@goauthentik.io> Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com> * Update website/docs/users-sources/access-control/initial_permissions.mdx Co-authored-by: Dewi Roberts <dewi@goauthentik.io> Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com> * dewi's edits * dominic's edits * gergo edits and more dominic edits * one more * yet one more fix * final gergo observation * tweak --------- Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com> Co-authored-by: Tana M Berry <tana@goauthentik.io> Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
151 lines
8.7 KiB
Markdown
151 lines
8.7 KiB
Markdown
---
|
|
title: "Manage permissions"
|
|
description: "Learn how to use global and object permissions in authentik."
|
|
---
|
|
|
|
For instructions on viewing and managing permissions, see the following topics.To learn more about the concepts and fundamentals of authentik permissions, refer to [About Permissions](./permissions.md).
|
|
|
|
To learn about using Initial Permissions, a pre-defined set of permissions, refer to our [documentation](./initial_permissions.mdx).
|
|
|
|
## View permissions
|
|
|
|
You can view all permissions that are assigned to a user, group, role, flow, or stage.
|
|
|
|
### View user and role permissions
|
|
|
|
To view _object_ permissions for a specific user or role:
|
|
|
|
1. Go to the Admin interface and navigate to **Directory**.
|
|
2. Select either **Users** or **Roles**
|
|
3. Select a specific user/role by clicking on the name (this opens the details page).
|
|
4. Click the **Permissions** tab at the top of the page
|
|
5. Select the **Assigned global permissions** sub-tab to see global permissions and the **Assigned object permissions** sub-tab to see the object-level permissions.
|
|
|
|
### View flow permissions
|
|
|
|
\_These instructions apply to all objects that have a detail page, which can be accessed by clicking on the name in the list page.\_\_
|
|
|
|
1. Go to the Admin interface and navigate to **Flows and Stages -> Flows**.
|
|
2. Click the name of the flow (this opens the details page).
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
4. View the assigned permissions using the **User Object Permissions** and the **Role Object Permissions** tabs.
|
|
|
|
### View stage permissions
|
|
|
|
_These instructions apply to all objects that **do not** have a detail page._
|
|
|
|
1. Go to the Admin interface and navigate to **Flows and Stages -> Stages**.
|
|
2. On the row for the specific stage whose permissions you want to view, click the **lock icon**.
|
|
3. On the **Update Permissions** window, you can view the assigned permissions using the **User Object Permissions** and the **Role Object Permissions** tabs.
|
|
|
|
## Manage permissions
|
|
|
|
You can assign or remove permissions to a user, role, group, flow, or stage.
|
|
|
|
### Assign, modify, or remove permissions for a user
|
|
|
|
To assign or remove _object_ permissions for a specific user:
|
|
|
|
1. Go to the Admin interface and navigate to **Directory -> Users**.
|
|
2. Select a specific user by clicking on the user's name.
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
4. To assign or remove permissions that another _user_ has on this specific user:
|
|
1. Click the **User Object Permissions** tab, and then click **Assign to new user**.
|
|
2. In the **User** drop-down, select the user object.
|
|
3. Use the toggles to set which permissions on that selected user object you want to grant to (or remove from) the specific user.
|
|
4. Click **Assign** to save your settings and close the box.
|
|
5. To assign or remove permissions that another _role_ has on this specific user:
|
|
1. Click the **Role Object Permissions** tab, and then click **Assign to new role**.
|
|
2. In the **User** drop-down, select the user object.
|
|
3. Use the toggles to set which permissions you want to grant to (or remove from) the selected role.
|
|
4. Click **Assign** to save your settings and close the box.
|
|
|
|
To assign or remove _global_ permissions for a user:
|
|
|
|
1. Go to the Admin interface and navigate to **Directory -> Users**.
|
|
2. Select a specific user the clicking on the user's name.
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
4. Click **Assigned Global Permissions** to the left.
|
|
5. In the **Assign permissions** area, click **Assign Permission**.
|
|
6. In the **Assign permission to user** box, click the plus sign (**+**) and then click the checkbox beside each permission that you want to assign to the user. To remove permissions, deselect the checkbox.
|
|
7. Click **Add**, and then click **Assign** to save your changes and close the box.
|
|
|
|
### Assign `Can view Admin interface` permissions
|
|
|
|
You can grant regular users, who are not superusers nor Admins, the right to view the Admin interface. This can be useful in scenarios where you have a team who needs to be able to create certain objects (flows, other users, etc) but who should not have full access to the Admin interface.
|
|
|
|
To assign the `Can view Admin interface` permission to a user (follow the same steps for a role):
|
|
|
|
1. Go to the Admin interface and navigate to **Directory -> User**.
|
|
2. Select a specific user the clicking on the user's name.
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
4. Click **Assigned Global Permissions** to the left.
|
|
5. In the **Assign permissions** area, click **Assign Permission**.
|
|
6. In the **Assign permission to user** box, click the plus sign (**+**), enter `admin` in the Search field and click the search icon.
|
|
7. Select the returned permission, click **Add**, and then click **Assign** to save your changes and close the box.
|
|
|
|
Be aware that any rights beyond viewing the Admin interface will need to be assigned as well; for example, if you want a non-administrator user to be able to create flows in the Admin interface, you need to grant those global permissions to add flows.
|
|
|
|
### Assign or remove object permissions on a group
|
|
|
|
:::info
|
|
Note that groups themselves do not have permissions. Rather, users and roles have permissions assigned that allow them to create, modify, delete, etc., a group.
|
|
Also there are no global permissions for groups.
|
|
:::
|
|
|
|
To assign or remove _object_ permissions on a specific group for users and roles:
|
|
|
|
1. Go to the Admin interface and navigate to **Directory -> Groups**.
|
|
2. Select a specific group by clicking the group's name.
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
To assign or remove permissions that another _user_ has on this specific group:
|
|
1. Click **User Object Permissions** to the left, and then click **Assign to new user**.
|
|
2. In the **User** drop-down, select the user object.
|
|
3. Use the toggles to set which permissions on that selected group you want to grant to (or remove from) the specific user.
|
|
4. Click **Assign** to save your settings and close the box.
|
|
4. To assign or remove permissions that another _role_ has on this specific group:
|
|
1. Click **Role Object Permissions** to the left, and then click **Assign to new role**.
|
|
2. In the **Role** drop-down, select the role.
|
|
3. Use the toggles to set which permissions you want to grant to (or remove from ) the selected role.
|
|
4. Click **Assign** to save your settings and close the box.
|
|
|
|
### Assign or remove permissions for a specific role
|
|
|
|
To assign or remove _object_ permissions for a specific role:
|
|
|
|
1. Go to the Admin interface and navigate to **Directory -> Roles**.
|
|
2. Select a specific role the clicking on the role's name.
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
To assign or remove permissions that another _user_ has on this specific role:
|
|
1. Click **User Object Permissions** to the left, and then click **Assign to new user**.
|
|
2. In the **User** drop-down, select the user object.
|
|
3. Use the toggles to set which permissions on that role you want to grant to (or remove from) the selected user.
|
|
4. Click **Assign** to save your settings and close the box.
|
|
4. To assign or remove permissions that another _role_ has on this specific group:
|
|
1. Click **Role Object Permissions** to the left, and then click **Assign to new role**.
|
|
2. In the **Role** drop-down, select the role.
|
|
3. Use the toggles to set which permissions you want to grant to (or remove from) the selected role.
|
|
4. Click **Assign** to save your settings and close the box.
|
|
|
|
To assign or remove _global_ permissions for a role:
|
|
|
|
1. Go to the Admin interface and navigate to **Directory -> Roles**.
|
|
2. Select a specific role by clicking on the role's name.
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
4. Click **Assigned Global Permissions** to the left, and then click **Assign Permission**.
|
|
5. In the **Assign permissions to role** box, click the plus sign (**+**) and then click the checkbox beside each permission that you want to assign to the role. To remove permissions, deselect the checkbox.
|
|
6. Click **Assign** to save your changes and close the box.
|
|
|
|
### Assign or remove flow permissions
|
|
|
|
1. Go to the Admin interface and navigate to **Flows and Stages -> Flows**.
|
|
2. Click the name of the flow (this opens the details page).
|
|
3. Click the **Permissions** tab at the top of the page.
|
|
4. Add or remove permissions using the **User Object Permissions** and the **Role Object Permissions** tabs.
|
|
|
|
### Assign or remove stage permissions
|
|
|
|
1. Go to the Admin interface and navigate to **Flows and Stages -> Stagess**.
|
|
2. On the row for the specific stage that you want to manage permissions, click the **lock icon**.
|
|
3. On the **Update Permissions** box, you can add or remove the assigned permissions using the **User Object Permissions** and the **Role Object Permissions** tabs.
|