Authentication and User Management#

class AuthTypeEnum(value)[source]#

Bases: str, Enum

password = 'password'#
is_valid_password(password)[source]#
Parameters:

password (str)

Return type:

None

is_valid_username(username)[source]#
Parameters:

username (str)

Return type:

None

is_valid_groupname(groupname)[source]#
Parameters:

groupname (str)

Return type:

None

class GroupInfo(*, id=None, groupname, description='')[source]#

Bases: BaseModel

Information about a group

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • id (int | None)

  • groupname (str)

  • description (str)

id: int | None#
groupname: str#
description: str#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class UserInfo(*, id=None, auth_type=AuthTypeEnum.password, username, role, groups=[], enabled, fullname='', organization='', email='')[source]#

Bases: BaseModel

Information about a user

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • id (int | None)

  • auth_type (AuthTypeEnum)

  • username (str)

  • role (str)

  • groups (list[str])

  • enabled (bool)

  • fullname (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=128, pattern=None, ascii_only=None)])

  • organization (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=128, pattern=None, ascii_only=None)])

  • email (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=128, pattern=None, ascii_only=None)])

id: int | None#
auth_type: AuthTypeEnum#
username: str#
role: str#
groups: list[str]#
enabled: bool#
fullname: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=128, pattern=None, ascii_only=None)]#
organization: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=128, pattern=None, ascii_only=None)]#
email: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=128, pattern=None, ascii_only=None)]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].