habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
19c5b28cb2510ce6205d08bd9f9ffecadb7df4a8
authentik/website/docs/users-sources/groups/group_ref.md
Dewi Roberts 64af0ccba6 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 <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Update website/docs/users-sources/groups/group_ref.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Update website/docs/users-sources/groups/group_ref.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Update website/docs/users-sources/groups/group_ref.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Update website/docs/users-sources/groups/group_ref.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Update website/docs/users-sources/groups/group_ref.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Update website/docs/users-sources/groups/group_ref.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Changes based on Tana's feedback

* Word

* Capitalization

---------

Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
2025-04-23 16:36:19 +01:00

1.0 KiB
Raw Blame History

title
title
Group properties and attributes

Object properties

The group object has the following properties:

  • 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.

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:

group.users.all()

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 for well-known attributes.