Files
authentik/docs/topics/users-sources/groups/group_ref.md
Teffen Ellis 582812b3ec website: Flesh out docs split.
website: Copy files during build.

website: Allow for mixed env builds.

website: Reduce build size.

website: Expose build.

website: Add build memory debugging.

WIP: Disable broken links check to compare memory usage.

website: Update deps.

website: Clean up API paths.

website: Flesh out 3.8 fixes.

Format.

website: Update ignore paths.

Website: Clean up integrations build.

website: Fix paths.

website: Optimize remark.

website: Update deps.

website: Format.

website: Remove linking.

website: Fix paths.

wip: Attempt API only build.

Prep.

Migrate render to runtime. Tidy sidebar.

Clean up templates.

docs: Move directory. WIP

docs: Flesh out split.

website: Fix issue where routes have collisions.
2025-07-01 21:53:19 +02:00

1.0 KiB

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.