From 64af0ccba6d96654ea1ae5b5875c76d36a6d78e8 Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Wed, 23 Apr 2025 16:36:19 +0100 Subject: [PATCH] website/docs: adds code examples for getting user objects from a group object (#14101) * Added example of how to get user objects fro a group object * Updated wording * Updated wording, added titles to examples, capitalised group, added explanation of examples * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/docs/users-sources/groups/group_ref.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Changes based on Tana's feedback * Word * Capitalization --------- Signed-off-by: Dewi Roberts Co-authored-by: Tana M Berry --- .../docs/users-sources/groups/group_ref.md | 29 +++++++++++++++---- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/website/docs/users-sources/groups/group_ref.md b/website/docs/users-sources/groups/group_ref.md index f75dad609f..0d23cdd609 100644 --- a/website/docs/users-sources/groups/group_ref.md +++ b/website/docs/users-sources/groups/group_ref.md @@ -4,13 +4,32 @@ title: Group properties and attributes ## Object properties -The Group object has the following properties: +The group object has the following properties: -- `name` Group's display name. -- `is_superuser` Boolean field if the group's users are superusers. -- `parent` The parent Group of this Group. -- `attributes` Dynamic attributes, see [Attributes](#attributes) +- `name`: The group's display name. +- `is_superuser`: A boolean field that determines if the group's users are superusers. +- `parent`: The parent group of this group. +- `attributes`: Dynamic attributes, see [Attributes](#attributes). + +## Examples + +These are examples of how group objects can be used within authentik policies and property mappings. + +### List all group members + +Use the following examples to list all users that are members of a group: + +```python title="Get all members of a group object" +group.users.all() +``` + +```python title="Specify a group object based on name and return all of its members" +from authentik.core.models import Group +Group.objects.get(name="name of group").users.all() +``` ## Attributes +By default, authentik group objects are created with no attributes, however custom attributes can be set. + See [the user reference](../user/user_ref.mdx#attributes) for well-known attributes.