user.models.user

Module Contents

Classes

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

class user.models.user.SessionDict

Bases: typing_extensions.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.

property es_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]

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).

__tablename__ = 'users'

type: Column[str]

__mapper_args__

es_properties

es_public = False

id: Column[UUIDType]

username: Column[str]

password_hash: Column[str]

role: Column[str]

group_id: Column[UUIDType | None]

group: relationship[UserGroup | None]

realname: Column[str | None]

data: Column[dict[str, Any]]

second_factor: Column[dict[str, Any] | None]

source: Column[str | None]

source_id: Column[str | None]

active: Column[bool]

signup_token: Column[str | None]

__table_args__ = ()

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]

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

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.