member.models.AuthUser

class documentation

class AuthUser(AbstractBaseUser, PermissionsMixin): (source)

View In Hierarchy

Base user model

Method __str__ Undocumented
Method add_role add role to user :param role: group name (see AUTH_GROUPS)
Method set_roles updates user's groups :param roles: list of group names (see AUTH_GROUPS)
Constant USERNAME_FIELD Undocumented
Class Variable agreed_terms Undocumented
Class Variable alphanumeric Undocumented
Class Variable date_joined Undocumented
Class Variable email Undocumented
Class Variable has_temporary_password Undocumented
Class Variable is_active Undocumented
Class Variable objects Undocumented
Class Variable person Undocumented
Instance Variable is_staff Undocumented
Property is_onboarding whether the user has yet to go through the onboarding flow (i.e. an authenticated user that has a volunteer role)
Property name Undocumented
Property role_groups returns user's role groups
Property roles lists user's role names
def __str__(self): (source)

Undocumented

def add_role(self, role, commit=True): (source)

add role to user :param role: group name (see AUTH_GROUPS)

def set_roles(self, roles): (source)

updates user's groups :param roles: list of group names (see AUTH_GROUPS)

USERNAME_FIELD: str = (source)

Undocumented

Value
'email'
agreed_terms = (source)

Undocumented

alphanumeric = (source)

Undocumented

date_joined = (source)

Undocumented

email = (source)

Undocumented

has_temporary_password = (source)

Undocumented

is_active = (source)

Undocumented

objects = (source)

Undocumented

person = (source)

Undocumented

is_staff = (source)

Undocumented

@property
is_onboarding = (source)

whether the user has yet to go through the onboarding flow (i.e. an authenticated user that has a volunteer role)

@property
name = (source)

Undocumented

@property
role_groups = (source)

returns user's role groups

@property
roles = (source)

lists user's role names