SpaceUserAPI

class deepfos.api.space.SpaceUserAPI(root: deepfos.api.base.RootAPI)
all_enable_user(keyword=None, status=None)

查询空间用户信息

查询该空间下所有有效用户的基本信息

参数
返回类型

Union[List[UserInfoVo], Awaitable[List[UserInfoVo]]]

batch_query_by_user_ids(userIdList, status=None)

根据用户id列表批量查询用户信息

根据用户id列表批量查询用户的个人信息,不过滤当前空间用户,可根据 status字段筛选查询启用或者禁用的用户信息

参数
返回类型

Union[List[UserInfoVo], Awaitable[List[UserInfoVo]]]

check_user_exist_batch(userIdList, status=None)

批量校验用户在当前空间是否存在

批量校验一组用户在当前空间是否存在，存在返回其状态

参数
返回类型

Union[List[UserExistVo], Awaitable[List[UserExistVo]]]

get_all_children_user_list_by_group(groupId, status=None)

获取用户组内所有用户信息接口

获取用户组内所有用户信息（含子集组用户）

参数
返回类型

Union[List[UserVo], Awaitable[List[UserVo]]]

get_all_children_user_list_by_group_batch(groupIds)

批量获取用户组内所有用户信息接口

批量获取用户组内所有用户信息（含子集组用户）依赖平台版本2.6.7

参数

groupIds – List[str]

返回类型

Union[List[GroupUserDto], Awaitable[List[GroupUserDto]]]

query(userId, status=None)

根据id查询单个用户信息

根据用户的id查询单个用户的基本信息，包含邮箱，手机号，昵称等个人信息

参数
返回类型

Union[SingleUserVo, Awaitable[SingleUserVo]]

query_batch(userIdList, status=None)

根据用户id列表批量查询用户信息

根据用户id列表批量查询用户的个人信息,可根据status字段筛选查询 启用或者禁用的用户信息

参数
返回类型

List[UserInfoVo]

query_batch_by_name(userNames, status=None)

根据用户名批量查询空间用户集合

参数
返回类型

Union[List[UserInfoVo], Awaitable[List[UserInfoVo]]]

query_batch_by_user_ids(userIdList, status=None)

根据用户id列表批量查询用户信息

根据用户id列表批量查询用户的个人信息,可根据status字段筛选查询 启用或者禁用的用户信息

参数
返回类型

Union[List[UserInfoVo], Awaitable[List[UserInfoVo]]]

search(userSearchDto)

查询当前空间用户信息（可包含关键字,不分页）

根据给的作用域匹配对应用户信息

参数

userSearchDto – UserSearchDto

返回类型

Union[List[UserVo], Awaitable[List[UserVo]]]

update(updateInfo)

根据用户id更新用户状态及用户组

根据用户id更新用户状态为可用或者禁用状态，也可以传入用户组id为该用 户分配新的用户组

参数

updateInfo – UserUpdateDto

返回类型

Union[str, Awaitable[str]]