用户操作相关模型
class UserPermission(IntEnum)
用户权限级别
枚举项 | 枚举值 | 描述 |
---|---|---|
BANNED | -1 | 封禁用户权限 |
USER | 1 | 普通用户权限 |
ADMIN | 10 | 管理员权限 |
class UserCreateResult(BaseModel)
用户创建结果
字段名 | 类型 | 描述 |
---|---|---|
uuid | str | 用户唯一标识符 (UUID) |
userName | str | 用户名 |
permission | UserPermission | 用户权限级别 |
class UserModel(BaseModel)
用户信息模型
字段名 | 类型 | 描述 |
---|---|---|
uuid | str | 用户唯一标识符 (UUID) |
userName | str | 用户名 |
permission | UserPermission | 用户权限级别 |
registerTime | str | 用户注册时间 (YYYY/M/D hh:mm:ss) |
loginTime | str | 用户最后登录时间 (YYYY/M/D hh:mm:ss) |
apiKey | str | 用户 API 密钥 |
open2FA | bool | 是否启用双因素认证 (2FA) |
instances | list[UserInstancesList] | 用户关联的实例列表 |
isInit | bool | 是否为初始化用户 (已弃用) |
secret | str | 用户安全密钥 (已弃用) |
passWord | str | 用户密码(已弃用) |
passWordType | int | 密码类型 (已弃用) |
salt | str | 密码盐值 (已弃用) |
method delete(self)
删除该用户
返回
bool
: 删除成功时返回 True
method update(self, config: dict[str, Any])
更新该用户的信息
参数
config
: 用户的新信息,以字典形式提供,缺失内容使用原用户信息填充
返回
bool
: 更新成功时返回 True
class SearchUserModel(BaseModel)
用户搜索结果
字段名 | 类型 | 描述 |
---|---|---|
total | int | 匹配的用户总数 |
page | int | 当前页码 |
page_size | int | 每页返回的用户数量 |
max_page | int | 最大可用页数 |
data | list[UserModel] | 用户信息列表 |
class UserConfig(BaseModel)
用户配置信息
字段名 | 类型 | 描述 |
---|---|---|
uuid | str | 用户唯一标识符 (UUID) |
userName | str | 用户名 |
loginTime | str | 最后登录时间 |
registerTime | str | 注册时间 |
instances | list[InstanceDetail] | 用户拥有的实例列表 |
permission | int | 用户权限级别 |
passWord | str | 用户密码 |
open2FA | bool | 是否启用双因素认证 (2FA) |
apiKey | str | 用户 API 密钥 |
passWordType | int | 密码类型 (已弃用) |
isInit | bool | 是否为初始化用户 (已弃用) |
secret | str | 用户安全密钥 (已弃用) |
salt | str | 用户密码盐值 (已弃用) |