Skip to content

Commit b42a994

Browse files
authored
docs: add description of how to use permission system with external providers (#194)
1 parent c77918e commit b42a994

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/advanced/single-sign-on/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,11 @@ Homarr supports multiple authentication options, from internal userbase (credent
198198
| ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim | groups |
199199
| ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. By default it will use preferred_username if it does not contain a `@` and otherwise name. | --- |
200200

201+
### Permission System
201202

203+
To give a user special permissions, first create a new group in homarr and assign the permission desired.
204+
For example if the group on homarr is called `homarr-admins` a new group on the oidc provider, for example authentik needs to be created with the same name, that would be `homarr-admins`.
205+
After assigning the group on the oidc provider to the user, and logging again into homarr, the user should automatically get placed in that group and inherit the permissions defined.
202206

203207
</TabItem>
204208
</Tabs>

0 commit comments

Comments
 (0)