This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/docs/expressions/reference/user-object.md
Jens Langhammer a4c28a28b4 website/docs: improve docs for expressions
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-05-29 21:47:35 +02:00

988 B

title
User Object

The User object has the following attributes:

  • username: User's username.

  • email User's email.

  • name User's display name.

  • is_staff Boolean field if user is staff.

  • is_active Boolean field if user is active.

  • date_joined Date user joined/was created.

  • password_change_date Date password was last changed.

  • attributes Dynamic attributes.

  • group_attributes Merged attributes of all groups the user is member of and the user's own attributes.

  • ak_groups This is a queryset of all the user's groups.

    You can do additional filtering like

    user.ak_groups.filter(name__startswith='test')
    

    see here

    To get the name of all groups, you can do

    [group.name for group in user.ak_groups.all()]
    

Examples

List all the User's group names:

for group in user.ak_groups.all():
    yield group.name