mirror of
https://github.com/goauthentik/authentik.git
synced 2026-06-17 19:09:11 +03:00
website/docs: document group_uuid as a property for group object (#20865)
The application might need a unique id for a group to uniquely identify it. It can help in various cases like detecting group renames and more. We should document `group_uuid` field of the group object to make users aware that it can be used in custom property mappings. Signed-off-by: Shiv Tyagi <67995771+shiv-tyagi@users.noreply.github.com> Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
This commit is contained in:
@@ -7,6 +7,7 @@ title: Group properties and attributes
|
||||
The group object has the following properties:
|
||||
|
||||
- `name`: The group's display name.
|
||||
- `group_uuid`: The group's unique id.
|
||||
- `is_superuser`: A boolean field that determines if the group's users are superusers.
|
||||
- `parents`: The parent groups of this group.
|
||||
- `roles`: The roles directly assigned to this group.
|
||||
|
||||
Reference in New Issue
Block a user