Users

This package contains all user-related data models: User, Organization and FidoKey (see also django.contrib.auth.models.User for Django’s base user model)

Organization

class integreat_cms.cms.models.users.organization.Organization(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing an organization

Parameters:

• id (BigAutoField) – Primary key: ID

• name (CharField) – Name

• slug (SlugField) – Slug. Unique string identifier without spaces and special characters.

• last_updated (DateTimeField) – Modification date

• created_date (DateTimeField) – Creation date

• website (URLField) – Website

• archived (BooleanField) – Archived

Relationship fields:

Parameters:

• icon (ForeignKey to MediaFile) – Logo (related name: icon_organizations)

• region (ForeignKey to Region) – Region (related name: organizations)

• links (GenericRelation to Link) – Links (related name: organization)

Reverse relationships:

Parameters:

• pois (Reverse ForeignKey from POI) – All pois of this organization (related name of organization)

• pages (Reverse ForeignKey from Page) – All pages of this organization (related name of organization)

• members (Reverse ForeignKey from User) – All members of this organization (related name of organization)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

archive() → bool

Archives the organizations

Return type:

bool

archived

Type: BooleanField

Archived

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

backend_edit_link

This function returns the absolute url to the edit form of this region

Returns:

The url

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

created_date

Type: DateTimeField

Creation date

date_error_message(lookup_type, field_name, unique_for)

delete(*args: list, **kwargs: dict) → bool

Deletes the organization

Parameters:

• *args (list) – The supplied arguments

• **kwargs (dict) – The supplied keyword arguments

Return type:

bool

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_next_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=True, **kwargs)

Finds next instance based on created_date. See get_next_by_FOO() for more information.

get_next_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=True, **kwargs)

Finds next instance based on last_updated. See get_next_by_FOO() for more information.

get_previous_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=False, **kwargs)

Finds previous instance based on created_date. See get_previous_by_FOO() for more information.

get_previous_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=False, **kwargs)

Finds previous instance based on last_updated. See get_previous_by_FOO() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <Organization: Organization object (id)>. It is used for logging.

Returns:

The canonical string representation of the organization

Return type:

str

icon

Type: ForeignKey to MediaFile

Logo (related name: icon_organizations)

icon_id

Internal field, use icon instead.

id

Type: BigAutoField

Primary key: ID

property is_used: bool

Returns:

whether this organization is used by another model

last_updated

Type: DateTimeField

Modification date

links

Type: Reverse GenericRelation from Organization

All organization of this link (related name of links)

members

Type: Reverse ForeignKey from User

All members of this organization (related name of organization)

name

Type: CharField

Name

property num_contents: int

Returns:

the current number of maintained pages of an organization object

property num_members: int

Returns:

the current number of members of an organization object

objects = <django.db.models.Manager object>

pages

Type: Reverse ForeignKey from Page

All pages of this organization (related name of organization)

property pk

pois

Type: Reverse ForeignKey from POI

All pois of this organization (related name of organization)

prepare_database_save(field)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

region

Type: ForeignKey to Region

Region (related name: organizations)

region_id

Internal field, use region instead.

replace_urls(urls_to_replace: dict[str, str], user: User | None = None, commit: bool = True) → None

Function to replace links that are in the translation and match the given keyword search

Parameters:

• urls_to_replace (dict[str, str])

• user (User | None)

• commit (bool)

Return type:

None

restore() → None

Restores the organization

Return type:

None

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

classmethod search(region: Region, query: str) → QuerySet

Searches for all organizations which match the given query in their name. :param query: The query string used for filtering the organizations :return: A query for all matching objects

Parameters:

• region (Region)

• query (str)

Return type:

QuerySet

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

slug

Type: SlugField

Slug. Unique string identifier without spaces and special characters.

classmethod suggest(**kwargs: Any) → list[dict[str, Any]]

Suggests keywords for organization search

Parameters:

**kwargs (Any) – The supplied kwargs

Returns:

Json object containing all matching elements, of shape {title: str, url: str, type: str}

Return type:

list[dict[str, Any]]

property title: str

This function return the name of organization. Alias for link list template.

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

website

Type: URLField

Website

Role

class integreat_cms.cms.models.users.role.Role(*args, **kwargs)

Bases: AbstractBaseModel

Meta information about the default Django auth group model

Parameters:

• id (BigAutoField) – Primary key: ID

• name (CharField) –

  Name

  Manage choices in roles

• staff_role (BooleanField) – Staff role. Whether or not this role is designed for staff members

Relationship fields:

Parameters:

group (OneToOneField to Group) – Django auth group (related name: role)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

english_name

This returns the english name of a role which is used for logging

Returns:

The english name of the role

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_name_display(*, field=<django.db.models.CharField: name>)

Shows the label of the name. See get_FOO_display() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <Role: Role object (id)>. It is used for logging.

Returns:

The canonical string representation of the role

Return type:

str

group

Type: OneToOneField to Group

Django auth group (related name: role)

group_id

Internal field, use group instead.

id

Type: BigAutoField

Primary key: ID

name

Type: CharField

Name

Choices:

• MANAGEMENT

• EDITOR

• AUTHOR

• EVENT_MANAGER

• OBSERVER

• SERVICE_TEAM

• CMS_TEAM

• APP_TEAM

• MARKETING_TEAM

Manage choices in roles

objects = <django.db.models.Manager object>

property pk

prepare_database_save(field)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

staff_role

Type: BooleanField

Staff role. Whether or not this role is designed for staff members

classmethod suggest(**kwargs: Any) → list[dict[str, Any]]

Suggests keywords for searching the objects of the class

Parameters:

**kwargs (Any) – The supplied kwargs

Returns:

Json object containing all matching elements, of shape {title: str, url: str, type: str}

Return type:

list[dict[str, Any]]

To be implemented in the inheriting model

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

User

Custom user model that is used instead of the default Django user model

class integreat_cms.cms.models.users.user.CustomUserManager(*args, **kwargs)

Bases: UserManager

This manager prefetches the regions of each user because they are needed for permissions checks and the region selection anyway

__init__()

aaggregate(*args, **kwargs)

abulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

abulk_update(objs, fields, batch_size=None)

acontains(obj)

acount()

acreate(**kwargs)

aearliest(*fields)

aexists()

aexplain(*, format=None, **options)

afirst()

aget(*args, **kwargs)

aget_or_create(defaults=None, **kwargs)

aggregate(*args, **kwargs)

Return a dictionary containing the calculations (aggregation) over the current queryset.

If args is present the expression is passed as a kwarg using the Aggregate object’s default alias.

ain_bulk(id_list=None, *, field_name='pk')

aiterator(chunk_size=2000)

An asynchronous iterator over the results from applying this QuerySet to the database.

alast()

alatest(*fields)

alias(*args, **kwargs)

Return a query set with added aliases for extra data or aggregations.

all()

annotate(*args, **kwargs)

Return a query set in which the returned objects have been annotated with extra data or aggregations.

aupdate(**kwargs)

aupdate_or_create(defaults=None, **kwargs)

auto_created = False

bulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

Insert each of the instances into the database. Do not call save() on each of the instances, do not send any pre/post_save signals, and do not set the primary key attribute if it is an autoincrement field (except if features.can_return_rows_from_bulk_insert=True). Multi-table models are not supported.

bulk_update(objs, fields, batch_size=None)

Update the given fields in each of the given objects in the database.

check(**kwargs)

complex_filter(filter_obj)

Return a new QuerySet instance with filter_obj added to the filters.

filter_obj can be a Q object or a dictionary of keyword lookup arguments.

This exists to support framework features such as ‘limit_choices_to’, and usually it will be more natural to use other methods.

contains(obj)

Return True if the QuerySet contains the provided obj, False otherwise.

contribute_to_class(cls, name)

count()

Perform a SELECT COUNT() and return the number of records as an integer.

If the QuerySet is already fully cached, return the length of the cached results set to avoid multiple SELECT COUNT(*) calls.

create(**kwargs)

Create a new object with the given kwargs, saving it to the database and returning the created object.

create_superuser(username, email=None, password=None, **extra_fields)

create_user(username, email=None, password=None, **extra_fields)

creation_counter = 53

dates(field_name, kind, order='ASC')

Return a list of date objects representing all available dates for the given field_name, scoped to ‘kind’.

datetimes(field_name, kind, order='ASC', tzinfo=None, is_dst=<object object>)

Return a list of datetime objects representing all available datetimes for the given field_name, scoped to ‘kind’.

property db

db_manager(using=None, hints=None)

deconstruct()

Return a 5-tuple of the form (as_manager (True), manager_class, queryset_class, args, kwargs).

Raise a ValueError if the manager is dynamically generated.

defer(*fields)

Defer the loading of data for certain fields until they are accessed. Add the set of deferred fields to any existing set of deferred fields. The only exception to this is if None is passed in as the only parameter, in which case removal all deferrals.

difference(*other_qs)

distinct(*field_names)

Return a new QuerySet instance that will select only distinct results.

earliest(*fields)

exclude(*args, **kwargs)

Return a new QuerySet instance with NOT (args) ANDed to the existing set.

exists()

Return True if the QuerySet would have any results, False otherwise.

explain(*, format=None, **options)

Runs an EXPLAIN on the SQL query this QuerySet would perform, and returns the results.

extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

Add extra SQL fragments to the query.

filter(*args, **kwargs)

Return a new QuerySet instance with the args ANDed to the existing set.

first()

Return the first object of a query or None if no match is found.

classmethod from_queryset(queryset_class, class_name=None)

get(*args, **kwargs)

Perform the query and return a single object matching the given keyword arguments.

get_by_natural_key(username)

get_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, creating one if necessary. Return a tuple of (object, created), where created is a boolean specifying whether an object was created.

get_queryset() → QuerySet

Get the queryset of users including the prefetched regions

Returns:

The queryset of users

Return type:

QuerySet

in_bulk(id_list=None, *, field_name='pk')

Return a dictionary mapping each of the given IDs to the object with that ID. If id_list isn’t provided, evaluate the entire QuerySet.

intersection(*other_qs)

iterator(chunk_size=None)

An iterator over the results from applying this QuerySet to the database. chunk_size must be provided for QuerySets that prefetch related objects. Otherwise, a default chunk_size of 2000 is supplied.

last()

Return the last object of a query or None if no match is found.

latest(*fields)

Return the latest object according to fields (if given) or by the model’s Meta.get_latest_by.

make_random_password(length=10, allowed_chars='abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789')

Generate a random password with the given length and given allowed_chars. The default value of allowed_chars does not have “I” or “O” or letters and digits that look similar – just to avoid confusion.

none()

Return an empty QuerySet.

classmethod normalize_email(email)

Normalize the email address by lowercasing the domain part of it.

only(*fields)

Essentially, the opposite of defer(). Only the fields passed into this method and that are not already specified as deferred are loaded immediately when the queryset is evaluated.

order_by(*field_names)

Return a new QuerySet instance with the ordering changed.

prefetch_related(*lookups)

Return a new QuerySet instance that will prefetch the specified Many-To-One and Many-To-Many related objects when the QuerySet is evaluated.

When prefetch_related() is called more than once, append to the list of prefetch lookups. If prefetch_related(None) is called, clear the list.

raw(raw_query, params=(), translations=None, using=None)

reverse()

Reverse the ordering of the QuerySet.

select_for_update(nowait=False, skip_locked=False, of=(), no_key=False)

Return a new QuerySet instance that will select objects with a FOR UPDATE lock.

select_related(*fields)

Return a new QuerySet instance that will select related objects.

If fields are specified, they must be ForeignKey fields and only those related objects are included in the selection.

If select_related(None) is called, clear the list.

union(*other_qs, all=False)

update(**kwargs)

Update all elements in the current QuerySet, setting all the given fields to the appropriate values.

update_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, updating one with defaults if it exists, otherwise create a new one. Return a tuple (object, created), where created is a boolean specifying whether an object was created.

use_in_migrations = True

If set to True the manager will be serialized into migrations and will thus be available in e.g. RunPython operations.

using(alias)

Select which database this QuerySet should execute against.

values(*fields, **expressions)

values_list(*fields, flat=False, named=False)

with_perm(perm, is_active=True, include_superusers=True, backend=None, obj=None)

class integreat_cms.cms.models.users.user.User(*args, **kwargs)

Bases: AbstractUser, AbstractBaseModel

A custom User model that replaces the default Django User model

Parameters:

• id (BigAutoField) – Primary key: ID

• password (CharField) – Password

• last_login (DateTimeField) – Last login

• is_superuser (BooleanField) – Superuser status. Designates that this account has all permissions without explicitly assigning them.

• username (CharField) – Username. Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

• first_name (CharField) – First name

• last_name (CharField) – Last name

• email (EmailField) – Email address

• is_staff (BooleanField) – Staff status. Designates whether the user can log into this admin site.

• is_active (BooleanField) – Active. Designates whether this account should be treated as active. Unselect this instead of deleting accounts.

• date_joined (DateTimeField) – Date joined

• chat_last_visited (DateTimeField) – Last chat visit date. The date and time when the user did read the chat the last time

• expert_mode (BooleanField) – Experienced user. Enable this option to display additional features like XLIFF import/export, page filtering, mirrored pages, page-based permissions and status information for broken links

• page_tree_tutorial_seen (BooleanField) – Page tree tutorial seen. Will be set to true once the user dismissed the page tree tutorial

• distribute_sidebar_boxes (BooleanField) – Automatically distribute sidebar boxes. Enable this option to automatically distribute the boxes in the sidebar of forms to make the best use of screen space. This only affects screen resolutions where the boxes are displayed in two columns.

• totp_key (CharField) – TOTP key. Will be used to generate TOTP codes

• passwordless_authentication_enabled (BooleanField) – Enable passwordless authentication. Enable this option to activate the passwordless login routine for this account

• webauthn_id (BinaryField) – Webauthn id

Relationship fields:

Parameters:

• organization (ForeignKey to Organization) – Organization. This allows the user to edit and publish all pages for which the organisation is registered as the responsible organisation (related name: members)

• groups (ManyToManyField to Group) – Groups. The groups this user belongs to. A user will get all permissions granted to each of their groups. (related name: user_set)

• user_permissions (ManyToManyField to Permission) – User permissions. Specific permissions for this user. (related name: user_set)

• regions (ManyToManyField to Region) – Regions. The regions to which the user has access (related name: users)

Reverse relationships:

Parameters:

• chat_messages (Reverse ForeignKey from ChatMessage) – All chat messages of this user (related name of sender)

• event_translations (Reverse ForeignKey from EventTranslation) – All event translations of this user (related name of creator)

• page_translations (Reverse ForeignKey from PageTranslation) – All page translations of this user (related name of creator)

• poi_translations (Reverse ForeignKey from POITranslation) – All poi translations of this user (related name of creator)

• externalcalendar (Reverse ForeignKey from ExternalCalendar) – All external calendars of this user (related name of created_by)

• feedback (Reverse ForeignKey from Feedback) – All feedback of this user (related name of read_by)

• imprint_translations (Reverse ForeignKey from ImprintPageTranslation) – All imprint translations of this user (related name of creator)

• editable_pages (Reverse ManyToManyField from Page) – All editable pages of this user (related name of authors)

• publishable_pages (Reverse ManyToManyField from Page) – All publishable pages of this user (related name of editors)

• fido_keys (Reverse ForeignKey from FidoKey) – All fido keys of this user (related name of user)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

EMAIL_FIELD = 'email'

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

REQUIRED_FIELDS = ['email']

USERNAME_FIELD = 'username'

__init__(*args, **kwargs)

access_granted_pages(region: Region) → QuerySet[Page]

Get a list of all pages the user has been given explicit rights to edit

Parameters:

region (Region)

Return type:

QuerySet[Page]

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

chat_last_visited

Type: DateTimeField

Last chat visit date. The date and time when the user did read the chat the last time

chat_messages

Type: Reverse ForeignKey from ChatMessage

All chat messages of this user (related name of sender)

classmethod check(**kwargs)

check_password(raw_password)

Return a boolean of whether the raw_password was correct. Handles hashing formats behind the scenes.

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

date_joined

Type: DateTimeField

Date joined

delete(using=None, keep_parents=False)

distinct_region

If the user is no staff member and has exactly one region, this property returns it

Returns:

The only region of this user

distribute_sidebar_boxes

Type: BooleanField

Automatically distribute sidebar boxes. Enable this option to automatically distribute the boxes in the sidebar of forms to make the best use of screen space. This only affects screen resolutions where the boxes are displayed in two columns.

editable_pages

Type: Reverse ManyToManyField from Page

All editable pages of this user (related name of authors)

email

Type: EmailField

Email address

email_user(subject, message, from_email=None, **kwargs)

Send an email to this user.

event_translations

Type: Reverse ForeignKey from EventTranslation

All event translations of this user (related name of creator)

expert_mode

Type: BooleanField

Experienced user. Enable this option to display additional features like XLIFF import/export, page filtering, mirrored pages, page-based permissions and status information for broken links

externalcalendar_set

Type: Reverse ForeignKey from ExternalCalendar

All external calendars of this user (related name of created_by)

feedback

Type: Reverse ForeignKey from Feedback

All feedback of this user (related name of read_by)

fido_keys

Type: Reverse ForeignKey from FidoKey

All fido keys of this user (related name of user)

first_name

Type: CharField

First name

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

property full_user_name: str

Return the full name of the user. If either the first or the last name are present, return them, otherwise return the username.

Returns:

The full name of the user

get_all_permissions(obj=None)

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_email_field_name()

get_full_name()

Return the first_name plus the last_name, with a space in between.

get_group_permissions(obj=None)

Return a list of permission strings that this user has through their groups. Query all available auth backends. If an object is passed in, return only permissions matching this object.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_next_by_chat_last_visited(*, field=<django.db.models.DateTimeField: chat_last_visited>, is_next=True, **kwargs)

Finds next instance based on chat_last_visited. See get_next_by_FOO() for more information.

get_next_by_date_joined(*, field=<django.db.models.DateTimeField: date_joined>, is_next=True, **kwargs)

Finds next instance based on date_joined. See get_next_by_FOO() for more information.

get_previous_by_chat_last_visited(*, field=<django.db.models.DateTimeField: chat_last_visited>, is_next=False, **kwargs)

Finds previous instance based on chat_last_visited. See get_previous_by_FOO() for more information.

get_previous_by_date_joined(*, field=<django.db.models.DateTimeField: date_joined>, is_next=False, **kwargs)

Finds previous instance based on date_joined. See get_previous_by_FOO() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <User: User object (id)>. It is used for logging.

Returns:

The canonical string representation of the user

Return type:

str

get_session_auth_fallback_hash()

get_session_auth_hash()

Return an HMAC of the password field.

get_short_name()

Return the short name for the user.

get_user_permissions(obj=None)

Return a list of permission strings that this user has directly. Query all available auth backends. If an object is passed in, return only permissions matching this object.

get_username()

Return the username for this User.

groups

Type: ManyToManyField to Group

Groups. The groups this user belongs to. A user will get all permissions granted to each of their groups. (related name: user_set)

has_module_perms(app_label)

Return True if the user has any permissions in the given app label. Use similar logic as has_perm(), above.

has_perm(perm, obj=None)

Return True if the user has the specified permission. Query all available auth backends, but return immediately if any backend returns True. Thus, a user who has permission from a single auth backend is assumed to have permission in general. If an object is provided, check permissions for that object.

has_perms(perm_list, obj=None)

Return True if the user has each of the specified permissions. If object is passed, check if the user has all required perms for it.

has_totp

If the user has totp configured

Returns:

True if the user has totp configured, False otherwise

has_usable_password()

Return False if set_unusable_password() has been called for this user.

id

Type: BigAutoField

Primary key: ID

imprint_translations

Type: Reverse ForeignKey from ImprintPageTranslation

All imprint translations of this user (related name of creator)

is_active

Type: BooleanField

Active. Designates whether this account should be treated as active. Unselect this instead of deleting accounts.

property is_anonymous

Always return False. This is a way of comparing User objects to anonymous users.

property is_authenticated

Always return True. This is a way to tell if the user has been authenticated in templates.

is_staff

Type: BooleanField

Staff status. Designates whether the user can log into this admin site.

is_superuser

Type: BooleanField

Superuser status. Designates that this account has all permissions without explicitly assigning them.

last_login

Type: DateTimeField

Last login

last_name

Type: CharField

Last name

natural_key()

classmethod normalize_username(username)

objects = <integreat_cms.cms.models.users.user.CustomUserManager object>

Django manager to access the ORM Use User.objects.all() to fetch all objects.

Custom model manager for user objects

organization

Type: ForeignKey to Organization

Organization. This allows the user to edit and publish all pages for which the organisation is registered as the responsible organisation (related name: members)

organization_id

Internal field, use organization instead.

page_translations

Type: Reverse ForeignKey from PageTranslation

All page translations of this user (related name of creator)

page_tree_tutorial_seen

Type: BooleanField

Page tree tutorial seen. Will be set to true once the user dismissed the page tree tutorial

password

Type: CharField

Password

passwordless_authentication_enabled

Type: BooleanField

Enable passwordless authentication. Enable this option to activate the passwordless login routine for this account

property pk

poi_translations

Type: Reverse ForeignKey from POITranslation

All poi translations of this user (related name of creator)

prepare_database_save(field)

publishable_pages

Type: Reverse ManyToManyField from Page

All publishable pages of this user (related name of editors)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

regions

Type: ManyToManyField to Region

Regions. The regions to which the user has access (related name: users)

role

We refer to Django user groups as roles.

Returns:

The role of this user

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

set_password(raw_password)

set_unusable_password()

classmethod suggest(**kwargs: Any) → list[dict[str, Any]]

Suggests keywords for user search

Parameters:

**kwargs (Any) – The supplied kwargs

Returns:

Json object containing all matching elements, of shape {title: str, url: str, type: str}

Return type:

list[dict[str, Any]]

totp_key

Type: CharField

TOTP key. Will be used to generate TOTP codes

unique_error_message(model_class, unique_check)

property unread_chat_messages: QuerySet[ChatMessage]

Return all unread messages of this user

Returns:

The unread messages of this user

update_chat_last_visited() → datetime

Update the chat_last_visited to the current time

Returns:

the previous chat_last_visited value

Return type:

datetime

user_permissions

Type: ManyToManyField to Permission

User permissions. Specific permissions for this user. (related name: user_set)

username

Type: CharField

Username. Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

username_validator = <django.contrib.auth.validators.UnicodeUsernameValidator object>

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

webauthn_id

Type: BinaryField

Webauthn id

User Fido Key

class integreat_cms.cms.models.users.user_fido_key.FidoKey(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a user’s FIDO key

Parameters:

• id (BigAutoField) – Primary key: ID

• name (CharField) – Key name

• key_id (BinaryField) – WebAuthn ID

• public_key (BinaryField) – Multi-factor-authentication public key

• sign_count (IntegerField) – Sign count. Token to prevent replay attacks.

• last_usage (DateTimeField) – Last date of use

• created_at (DateTimeField) – Creation date

Relationship fields:

Parameters:

user (ForeignKey to User) – User (related name: fido_keys)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

created_at

Type: DateTimeField

Creation date

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_next_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=True, **kwargs)

Finds next instance based on created_at. See get_next_by_FOO() for more information.

get_previous_by_created_at(*, field=<django.db.models.DateTimeField: created_at>, is_next=False, **kwargs)

Finds previous instance based on created_at. See get_previous_by_FOO() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <UserMfaKey: UserMfaKey object (id)>. It is used for logging.

Returns:

The canonical string representation of the user MFA

Return type:

str

id

Type: BigAutoField

Primary key: ID

key_id

Type: BinaryField

WebAuthn ID

last_usage

Type: DateTimeField

Last date of use

name

Type: CharField

Key name

objects = <django.db.models.Manager object>

property pk

prepare_database_save(field)

public_key

Type: BinaryField

Multi-factor-authentication public key

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

sign_count

Type: IntegerField

Sign count. Token to prevent replay attacks.

classmethod suggest(**kwargs: Any) → list[dict[str, Any]]

Suggests keywords for searching the objects of the class

Parameters:

**kwargs (Any) – The supplied kwargs

Returns:

Json object containing all matching elements, of shape {title: str, url: str, type: str}

Return type:

list[dict[str, Any]]

To be implemented in the inheriting model

unique_error_message(model_class, unique_check)

user

Type: ForeignKey to User

User (related name: fido_keys)

user_id

Internal field, use user instead.

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.