user.models.user

Classes

SessionDict	dict() -> new empty dictionary
User	Defines a generic user.

Module Contents

class user.models.user.SessionDict

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

address: str | None

timestamp: str

agent: str | None

class user.models.user.User

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin, onegov.search.ORMSearchable

Defines a generic user.

__tablename__ = 'users'

type: sqlalchemy.orm.Mapped[str]

__mapper_args__

fts_type_title

Returns the display name for this type of document or a callable which accepts the current request as a single positional argument and returns the display name.

fts_title_property = 'title'

fts_properties

Returns the type mapping of this model. Each property in the mapping will be read from the model instance.

fts_public = False

Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results.

property fts_suggestion: tuple[str, str]

Returns suggest-as-you-type value of the document. The field used for this property should also be indexed, or the suggestion will lead to nowhere.

If a single string is returned, the completion input equals the completion output. (My Title -> My Title)

If an array of strings is returned, all values are possible inputs and the first value is the output. (My Title/Title My -> My Title)

property userprofile: list[str]

id: sqlalchemy.orm.Mapped[uuid.UUID]

username: sqlalchemy.orm.Mapped[str]

password_hash: sqlalchemy.orm.Mapped[str]

role: sqlalchemy.orm.Mapped[str]

groups: sqlalchemy.orm.Mapped[list[onegov.user.models.group.UserGroup]]

realname: sqlalchemy.orm.Mapped[str | None]

data: sqlalchemy.orm.Mapped[dict[str, Any]]

second_factor: sqlalchemy.orm.Mapped[dict[str, Any] | None]

source: sqlalchemy.orm.Mapped[str | None]

source_id: sqlalchemy.orm.Mapped[str | None]

active: sqlalchemy.orm.Mapped[bool]

last_login: sqlalchemy.orm.Mapped[datetime.datetime | None]

signup_token: sqlalchemy.orm.Mapped[str | None]

__table_args__

role_mappings: sqlalchemy.orm.DynamicMapped[onegov.user.RoleMapping]

api_keys: sqlalchemy.orm.DynamicMapped[onegov.api.models.ApiKey]

tickets: sqlalchemy.orm.Mapped[list[onegov.ticket.Ticket]]

title() → str

Returns the realname or the username of the user, depending on what’s available first.

classmethod _title_expression() → sqlalchemy.ColumnElement[str]

password() → str

An alias for password_hash.

is_matching_password(password: str) → bool

Returns True if the given password (cleartext) matches the stored password hash.

classmethod get_initials(username: str, realname: str | None = None) → str

Takes the name and returns initials which are at most two characters wide.

Examples:

admin => A nathan.drake@example.org => ND Victor Sullivan => VS Charles Montgomery Burns => CB

property initials: str

property has_yubikey: bool

property yubikey: str | None

property yubikey_serial: int | None

Returns the yubikey serial of the yubikey associated with this user (if any).

property mtan_phone_number: str | None

sessions: onegov.core.orm.mixins.dict_property[dict[str, SessionDict] | None]

tags: onegov.core.orm.mixins.dict_property[list[str] | None]

phone_number: onegov.core.orm.mixins.dict_property[str | None]

cleanup_sessions(app: onegov.core.framework.Framework) → None

Removes stored sessions not valid anymore.

save_current_session(request: onegov.core.request.CoreRequest) → None

Stores the current browser session.

remove_current_session(request: onegov.core.request.CoreRequest) → None

Removes the current browser session.

logout_all_sessions(app: onegov.core.framework.Framework) → int

Terminates all open browser sessions.