Authentication and User Management#
- class AuthTypeEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#
Bases:
str
,Enum
- password = 'password'#
- pydantic model GroupInfo[source]#
Bases:
BaseModel
Information about a group
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- Config:
extra: Extra = Extra.forbid
- Fields:
- Validators:
_valid_groupname
»groupname
- field id: int | None = None#
ID of the group
- field groupname: str [Required]#
The name of the group
- Validated by:
_valid_groupname
- field description: str = ''#
Text description of the group
- pydantic model UserInfo[source]#
Bases:
BaseModel
Information about a user
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- Config:
extra: Extra = Extra.forbid
validate_assignment: bool = True
- Fields:
- Validators:
- field id: int | None = None#
The id of the user
- field auth_type: AuthTypeEnum = AuthTypeEnum.password#
Type of authentication the user uses
- field username: str [Required]#
The username of this user
- Validated by:
_valid_username
- field role: str [Required]#
The role this user belongs to
- field groups: List[str] = []#
Groups this user belongs to
- Validated by:
_valid_groupnames
- field enabled: bool [Required]#
Whether this user is enabled or not
- field fullname: ConstrainedStrValue = ''#
The full name or description of the user
- Constraints:
maxLength = 128
- field organization: ConstrainedStrValue = ''#
The organization the user belongs to
- Constraints:
maxLength = 128
- field email: ConstrainedStrValue = ''#
The email address for the user
- Constraints:
maxLength = 128