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/user-group/user.md
Jens Langhammer 971de4fcb9 core: add USER_ATTRIBUTE_CHANGE_EMAIL
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>

#1590 and #1677
2021-10-27 13:34:11 +02:00

1.6 KiB

title
User

Attributes

goauthentik.io/user/can-change-username

Optional flag, when set to false prevents the user from changing their own username.

goauthentik.io/user/can-change-email

Optional flag, when set to false prevents the user from changing their own email.

goauthentik.io/user/token-expires:

Optional flag, when set to false, Tokens created by the user will not expire.

goauthentik.io/user/debug:

See Troubleshooting access problems, when set, the user gets a more detailed explanation of access decisions.

Object attributes

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, see above

  • 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