Authentication and User Management

class AuthTypeEnum

Bases: str, Enum

password = 'password'

__init__(*args, **kwds)

is_valid_password(password)

Parameters:

password (str)

Return type:

None

is_valid_username(username)

Parameters:

username (str)

Return type:

None

is_valid_groupname(groupname)

Parameters:

groupname (str)

Return type:

None

class GroupInfo

Bases: BaseModel

Information about a group

Fields

Field	Type	Required	Default
description	str	No	''
groupname	str	Yes
id	int | None	No	None

id: int | None

ID of the group

groupname: str

The name of the group

description: str

Text description of the group

class UserInfo

Bases: BaseModel

Information about a user

Fields

Field	Type	Required	Default	Constraints
auth_type	AuthTypeEnum	No	<AuthTypeEnum.password: 'password'>
email	str	No	''	max_length=128
enabled	bool	Yes
fullname	str	No	''	max_length=128
groups	list[str]	No	[]
id	int | None	No	None
organization	str	No	''	max_length=128
role	str	Yes
username	str	Yes

id: int | None

The id of the user

auth_type: AuthTypeEnum

Type of authentication the user uses

username: str

The username of this user

role: str

The role this user belongs to

groups: list[str]

Groups this user belongs to

enabled: bool

Whether this user is enabled or not

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

The full name or description of the user

Constraints:

• max_length = 128

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

The organization the user belongs to

Constraints:

• max_length = 128

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

The email address for the user

Constraints:

• max_length = 128