# # Copyright (C) 2020 GNS3 Technologies Inc. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . from datetime import datetime from typing import List, Optional from uuid import UUID from pydantic import BaseModel, ConfigDict, EmailStr, Field, SecretStr from ..update import PartialUpdateModel from .base import DateTimeModelMixin class UserBase(BaseModel): """ Common user properties. """ username: Optional[str] = Field(None, min_length=3, pattern="[a-zA-Z0-9_-]+$") is_active: bool = True email: Optional[EmailStr] = None full_name: Optional[str] = None class UserCreate(UserBase): """ Properties to create a user. """ username: str = Field(..., min_length=3, pattern="[a-zA-Z0-9_-]+$") password: SecretStr = Field(..., min_length=8, max_length=100) class UserUpdate(PartialUpdateModel, UserBase): """ Properties to update a user. """ password: Optional[SecretStr] = Field(None, min_length=8, max_length=100) class LoggedInUserUpdate(BaseModel): """ Properties to update a logged-in user. """ password: Optional[SecretStr] = Field(None, min_length=8, max_length=100) email: Optional[EmailStr] = None full_name: Optional[str] = None class User(DateTimeModelMixin, UserBase): user_id: UUID last_login: Optional[datetime] = None is_superadmin: bool = False model_config = ConfigDict(from_attributes=True) class UserPrivileges(BaseModel): """ Effective privileges of the logged in user, flattened across all roles assigned to the user (directly or through group membership). This is a hint for rendering purposes only: the server remains the authority for permission checks and can still deny a privilege listed here on a specific resource path. """ is_superadmin: bool privileges: List[str] class UserGroupBase(BaseModel): """ Common user group properties. """ name: Optional[str] = Field(None, min_length=3, pattern="[a-zA-Z0-9_-]+$") class UserGroupCreate(UserGroupBase): """ Properties to create a user group. """ name: str = Field(..., min_length=3, pattern="[a-zA-Z0-9_-]+$") class UserGroupUpdate(UserGroupBase): """ Properties to update a user group. """ pass class UserGroup(DateTimeModelMixin, UserGroupBase): user_group_id: UUID is_builtin: bool model_config = ConfigDict(from_attributes=True) class Credentials(BaseModel): username: str password: str