Skip to content

用户操作相关模型

class UserPermission(IntEnum)

用户权限级别

枚举项枚举值描述
BANNED-1封禁用户权限
USER1普通用户权限
ADMIN10管理员权限

class UserCreateResult(BaseModel)

用户创建结果

字段名类型描述
uuidstr用户唯一标识符 (UUID)
userNamestr用户名
permissionUserPermission用户权限级别

class UserModel(BaseModel)

用户信息模型

字段名类型描述
uuidstr用户唯一标识符 (UUID)
userNamestr用户名
permissionUserPermission用户权限级别
registerTimestr用户注册时间 (YYYY/M/D hh:mm:ss)
loginTimestr用户最后登录时间 (YYYY/M/D hh:mm:ss)
apiKeystr用户 API 密钥
open2FAbool是否启用双因素认证 (2FA)
instanceslist[UserInstancesList]用户关联的实例列表
isInitbool是否为初始化用户 (已弃用)
secretstr用户安全密钥 (已弃用)
passWordstr用户密码(已弃用)
passWordTypeint密码类型 (已弃用)
saltstr密码盐值 (已弃用)

method delete(self)

删除该用户

返回

  • bool: 删除成功时返回 True

method update(self, config: dict[str, Any])

更新该用户的信息

参数

  • config: 用户的新信息,以字典形式提供,缺失内容使用原用户信息填充

返回

  • bool: 更新成功时返回 True

class SearchUserModel(BaseModel)

用户搜索结果

字段名类型描述
totalint匹配的用户总数
pageint当前页码
page_sizeint每页返回的用户数量
max_pageint最大可用页数
datalist[UserModel]用户信息列表

class UserConfig(BaseModel)

用户配置信息

字段名类型描述
uuidstr用户唯一标识符 (UUID)
userNamestr用户名
loginTimestr最后登录时间
registerTimestr注册时间
instanceslist[InstanceDetail]用户拥有的实例列表
permissionint用户权限级别
passWordstr用户密码
open2FAbool是否启用双因素认证 (2FA)
apiKeystr用户 API 密钥
passWordTypeint密码类型 (已弃用)
isInitbool是否为初始化用户 (已弃用)
secretstr用户安全密钥 (已弃用)
saltstr用户密码盐值 (已弃用)

Released under the MIT License.