User服务
1.服务功能
- 云平台所提供User服务，主要是对用户密码安全，用户个人信息采集，账号绑定修改，内部员工信息批量操作等业务功能
- 云平台具备一整套完善的用户管理系统化接口，方便，快捷的使您的用户进行信息资源的操作
- 对于公司员工，也可以高效率的，高统一化的进行管理
2.使用场景
- 用户管理等相关功能在互联网行业中大同小异，专业化，个性化，隐私化，是云平台对于用户信息处理独具特色的地方
- 作为行业中发展最具潜力的新生代，云平台致力于个性化定制客户需求，用细致，严谨的态度来实现客户的需求
- 如果您的公司正处于用户量增加态势，又希望有大型的平台，完善的用户系统为您公司接下来的业务打下夯实的基础，云平台的User服务是您不错的选择
用户履历服务
1.创建履历
POST https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}}/resumes
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| previousPosition | String | 否 | 曾任职务 |
| workYears | Integer | 否 | 工作年限 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| id | String | 存储id值 |
| previousPosition | String | 曾任职务 |
| workYears | Integer | 工作年限 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136/resumes
2.修改履历
PUT https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/resumes/{resumeId}
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
| resumeId | String | 是 | 履历id |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| previousPosition | String | 否 | 曾任职务 |
| workYears | Integer | 否 | 工作年限 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| id | String | 简历id |
| previousPosition | String | 曾任职务 |
| workYears | Integer | 工作年限 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136/resumes/5FY8
3.删除履历
DELETE https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/resumes/{resumeId}
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（PATH）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
| resumeId | String | 是 | 履历id |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136/resumes/5FY8
用户信息服务
4.用户注册
POST https://api.cloud.pkpm.cn/bimserver/user/v3/users
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| clientId | String | 是 | 应用id |
| company | String | 否 | 公司 |
| companyAddress | String | 否 | 公司地址 |
| department | String | 否 | 部门 |
| String | phoneNumber与email必填其一 | 邮箱 | |
| employeeNumber | String | 否 | 工号 |
| kaptcha | String | 否 | 验证码 |
| password | String | 否 | 密码 |
| phoneNumber | String | phoneNumber与email必填其一 | 电话号 |
| realName | String | 否 | 姓名 |
| referrer | String | 否 | 推荐人 |
| remark | String | 否 | 备注 |
| title | String | 否 | 职称 |
| userType | String | 否 | 用户类型 |
| username | String | 否 | 用户名 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| userid | String | 用户id |
| username | String | 用户名 |
| String | 邮箱 | |
| phoneNumber | String | 手机号 |
| phoneNumberValidated | Boolean | 手机号是否被验证过 |
| realName | String | 姓名 |
| displayName | String | 展示名称 |
| gender | Integer | 性别 0:女 1:男 |
| qqNumber | String | QQ号 |
| birthDate | Date | 生日 |
| company | String | 所属公司/单位 |
| department | String | 所属部门 |
| companyAddress | String | 所属公司/单位地址 |
| title | String | 职称 |
| country | String | 国家 |
| city | String | 所属城市 |
| district | String | 所属区 |
| address | String | 详细地址 |
| postcode | String | 邮政编码 |
| avatarLink | String | 头像链接 |
| cardSetting | String | 名片设置 |
| enabled | String | 是否可用 |
| education | String | 学历 |
| workTime | String | 参加工作时间 |
| titleCertificate | String | 职称证书 |
| professionCertificate | String | 职业资格证书 |
| resumes | Set | 履历 |
| notifySettings | Set | 通知设置 |
| remark | String | 备注 |
| inviteCode | String | 自己的邀请码 |
| referrer | String | 推荐人的邀请码 |
| employeeNumber | String | 工号 |
| createAt | Date | 创建时间 |
| updateAt | Date | 修改时间 |
| userType | String | 用户类型:企业用户或个人用户 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users
5.用户查询
POST **https://api.cloud.pkpm.cn/bimserver/user/v3/users/search **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Params）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| matchType | Integer | 是 | 匹配类型 1:根据邮箱/姓名/手机号模糊查询 2:根据 userName 的列表进行精确查询, 会返回每一个UserName对应的Model不存在的用户信息时会抛出异常 3:根据 userName 的列表进行查询,不存在的不返回,不会返回异常 4: 根据namespace查询用户列表 |
| searchParam | String | 否 | 邮箱/姓名/手机号 |
| pageNumber | int | 否 | 页数 |
| pageSize | int | 否 | 每页条数 |
| namespace | String | 否 | namespace |
| userNames | List<String> | 否 | 查询用到的 UserName 的列表 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| items | List | 条目 |
| userid | String | 用户Id |
| username | String | 用户名 |
| String | 邮箱 | |
| phoneNumber | String | 手机号 |
| phoneNumberValidated | Boolean | 手机号是否被验证 |
| realName | String | 姓名 |
| displayName | String | 展示名称 |
| gender | Integer | 性别 0:女 1:男 |
| qqNumber | String | QQ号 |
| birthDate | Date | 生日 |
| company | String | 所属公司/单位 |
| companyAddress | String | 所属公司/单位地址 |
| department | String | 所属部门 |
| title | String | 职称 |
| country | String | 国家 |
| province | String | 所属省份 |
| city | String | 所属城市 |
| district | String | 所属区 |
| address | String | 详细地址 |
| postcode | String | 邮政编码 |
| avatarLink | String | 头像链接 |
| cardSetting | String | 名片设置 |
| enabled | Boolean | 是否可用 |
| education | String | 学历 |
| workTime | Timestamp | 参加工作时间 |
| titleCertificate | String | 职称证书 |
| professionCertificate | String | 职业资格证书 |
| resumes | Set | 履历 |
| inviteCode | String | 自己的邀请码 |
| referrer | String | 推荐人的邀请码 |
| employeeNumber | String | 工号 |
| createAt | Date | 创建时间 |
| updateAt | Date | 修改时间 |
| userType | String | 用户类型:企业用户或个人用户 |
| hasNext | Boolean | 是否有下一页 |
| hasPrevious | Boolean | 是否有上一页 |
| pageNumber | Integer | 当前是第几页 |
| pageSize | Integer | 当前页的最大记录数 |
| totalElements | Integer | 内容总共有多少条 |
| totalPage | Integer | 总共有多少页 |
| count | Integer | 对象的个数 |
| first | Boolean | 起始 |
| last | Boolean | 最终 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/search?matchType=1&searchParam=13614427055&pageNumber=1&pageSize=10&namespace=阿萨斯
6.修改用户信息
PUT **https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId} **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 用户ID/邮箱/手机号 |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| realName | String | 否 | 姓名 |
| gender | Integer | 否 | 性别 0:女 1:男 |
| birthDate | Timestamp | 否 | 生日 |
| qqNumber | String | 否 | QQ号 |
| company | String | 否 | 所属公司/单位 |
| companyAddress | String | 否 | 所属公司/单位地址 |
| department | String | 否 | 所属部门 |
| title | String | 否 | 职称 |
| country | String | 否 | 国家 |
| province | String | 否 | 所属省份 |
| city | String | 否 | 所属城市 |
| district | String | 否 | 所属区 |
| address | String | 否 | 详细地址 |
| postcode | String | 否 | 邮政编码 |
| avatarLink | String | 否 | 用户头像链接 |
| cardSetting | String | 否 | 名片设置 |
| education | String | 否 | 学历 |
| workTime | Timestamp | 否 | 参加工作时间 |
| titleCertificate | String | 否 | 职称证书 |
| professionCertificate | String | 否 | 职业资格证书 |
| referrer | String | 否 | 推荐人 |
| remark | String | 否 | 备注信息,range(0,500] |
| notifySettings | Set<String> | 否 | 通知设置; 可取值的通知类型: sms, email, wechat |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| items | List | 条目 |
| userid | String | 用户Id |
| username | String | 用户名 |
| String | 邮箱 | |
| phoneNumber | String | 手机号 |
| phoneNumberValidated | Boolean | 手机号是否被验证 |
| realName | String | 姓名 |
| displayName | String | 展示名称 |
| gender | Integer | 性别 0:女 1:男 |
| qqNumber | String | QQ号 |
| birthDate | Date | 生日 |
| company | String | 所属公司/单位 |
| companyAddress | String | 所属公司/单位地址 |
| department | String | 所属部门 |
| title | String | 职称 |
| country | String | 国家 |
| province | String | 所属省份 |
| city | String | 所属城市 |
| district | String | 所属区 |
| address | String | 详细地址 |
| postcode | String | 邮政编码 |
| avatarLink | String | 头像链接 |
| cardSetting | String | 名片设置 |
| enabled | Boolean | 是否可用 |
| education | String | 学历 |
| workTime | Timestamp | 参加工作时间 |
| titleCertificate | String | 职称证书 |
| professionCertificate | String | 职业资格证书 |
| resumes | Set | 履历 |
| inviteCode | String | 自己的邀请码 |
| referrer | String | 推荐人的邀请码 |
| employeeNumber | String | 工号 |
| createAt | Date | 创建时间 |
| updateAt | Date | 修改时间 |
| userType | String | 用户类型:企业用户或个人用户 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136
7.根据用户id/邮箱/手机号 修改密码
PUT **https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/password **
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| code | String | 是 | 验证码 |
| confirmNewPassword | String | 是 | 确认新密码 |
| newPassword | String | 是 | 新密码 |
| oldPassword | String | 否 | 旧密码 |
| matchType | String | 否 | 验证码 匹配类型，1:根据密码重置密码， 2:不需要原密码（需要具有'ROLE_USER_ADMIN'角色）， 3:根据短信验证码修改密码， 4.根据邮箱验证码修改密码 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/1777/password
8.根据用户id/邮箱/手机号 修改用户状态
PUT **https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/state **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| enabled | Boolean | 是 | 是否开启 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/1/state
9.获取用户社交信息
GET **https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/socialinfo **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| socials | List | 社交信息 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136/socialinfo
10.根据用户id获取信息
GET **https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId} **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| items | List | 条目 |
| userid | String | 用户Id |
| username | String | 用户名 |
| String | 邮箱 | |
| phoneNumber | String | 手机号 |
| phoneNumberValidated | Boolean | 手机号是否被验证 |
| realName | String | 姓名 |
| displayName | String | 展示名称 |
| gender | Integer | 性别 0:女 1:男 |
| qqNumber | String | QQ号 |
| birthDate | Date | 生日 |
| company | String | 所属公司/单位 |
| companyAddress | String | 所属公司/单位地址 |
| department | String | 所属部门 |
| title | String | 职称 |
| country | String | 国家 |
| province | String | 所属省份 |
| city | String | 所属城市 |
| district | String | 所属区 |
| address | String | 详细地址 |
| postcode | String | 邮政编码 |
| avatarLink | String | 头像链接 |
| cardSetting | String | 名片设置 |
| enabled | Boolean | 是否可用 |
| education | String | 学历 |
| workTime | Timestamp | 参加工作时间 |
| titleCertificate | String | 职称证书 |
| professionCertificate | String | 职业资格证书 |
| resumes | Set | 履历 |
| inviteCode | String | 自己的邀请码 |
| referrer | String | 推荐人的邀请码 |
| employeeNumber | String | 工号 |
| createAt | Date | 创建时间 |
| updateAt | Date | 修改时间 |
| userType | String | 用户类型:企业用户或个人用户 |
注：username和userid的值相等，username可以作为查询的条件字段，真实姓名是realName，显示姓名是displayName（展示优先级realName>phone=email）
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136
11.检查用户是否存在
GET **https://api.cloud.pkpm.cn/bimserver/user/v3/users/checkExist **
请求参数（Params）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| exist | Boolean | 是否存在 |
| phoneNumberValidated | Boolean | 手机号码是否存在 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/checkExist?userId=123
批量操作用户信息服务
12.批量创建用户
POST https://api.cloud.pkpm.cn/bimserver/user/v3/users/batch
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| users | List | 否 | 用户 |
| company | String | 否 | 公司 |
| String | 否 | 邮箱 | |
| password | String | 否 | 密码 |
| phoneNumber | String | 否 | 电话号 |
| realName | String | 否 | 姓名 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| userId | String | 用户id |
| username | String | 用户姓名 |
| String | 邮箱 | |
| phoneNumber | String | 邮箱 |
| realName | String | 姓名 |
| createAt | Timestamp | 创建时间 |
| userType | String | 用户类型 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/batch
13.批量检查邮箱在系统中是否存在
POST **https://api.cloud.pkpm.cn/bimserver/user/v3/users/email/checkbatch **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| emails | Set | 是 | 邮箱集合 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| checkResults | Boolean | 是否存在 |
| map | Map<String,String> | 邮箱描述 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/email/checkbatch
14.批量检查手机号码在系统中是否存在
POST **https://api.cloud.pkpm.cn/bimserver/user/v3/users/phone/checkbatch **
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| phoneNumbers | Set | 是 | 手机号合集 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| checkResults | Map<String,SimpleUserModel> | 查询出信息的集合 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/phone/checkbatch
重置密码服务
15.获取验证码
GET https://api.cloud.pkpm.cn/bimserver/user/v3/users/captcha
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| code | 图片 | 生成一个验证码图片 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/captcha
16.发送重置密码链接到邮箱
POST https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/sendResetPwdLinkEmail
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（PATH）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| captcha | String | 是 | 验证码 |
| expiresIn | long | 是 | 过期时间，单位为秒 |
| routeUrl | String | 是 | 重置密码链接的路由地址 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/wy23131231312@163.com/sendResetPwdLinkEmail
17.检测重置密码的签证是否正确
POST https://api.cloud.pkpm.cn/bimserver/user/v3/users/verifyResetPwdSignature
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| signature | String | 是 | JWT中的签名 |
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/verifyResetPwdSignature
18.根据签证重置密码
PUT https://api.cloud.pkpm.cn/bimserver/user/v3/users/password/signature
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| captcha | String | 是 | 验证码 |
| confirmNewPassword | String | 是 | 确认密码 |
| newPassword | String | 是 | 新密码 |
| signature | String | 是 | JWT中的签名 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://https://api.cloud.pkpm.cn/bimserver/user/v3/users/password/signature
用户标签服务
19.创建用户标签
POST https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/labels
授权（Authorization）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（Path）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
请求体（BODY）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| label | String | 是 | 标签 |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| userId | String | 用户id |
| labels | List | 标签集合 |
| label | String | 标签 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136/labels
20.获取用户标签
GET https://api.cloud.pkpm.cn/bimserver/user/v3/users/{userId}/labels
授权（AUTHORIZATION）:
| 名称（Name） | 值(Value) | 描述（Description） |
|---|---|---|
| Type | Bearer Token | Token拼装形式 |
| Token | token值 |
请求参数（PATH）:
| 名称（Name） | 类型（Type） | 必填（Required） | 描述（Description） |
|---|---|---|---|
| userId | String | 是 | 格式分为(1.邮件格式 2.手机号格式 3.用户id) |
响应体（BODY）:
| 名称（Name） | 类型（Type） | 描述（Description） |
|---|---|---|
| userId | String | 用户id |
| labels | List | 标签集合 |
| label | String | 标签 |
响应消息（MESSAGES）:
| HTTP状态码 | 原因 |
|---|---|
| 401 | 未授权，请检查Authorization的Header的Access Token是否设置正确 |
| 403 | 无权访问请求的资源 |
| 404 | Not Found |
| 409 | 将要创建的资源已经存在，拒绝重复创建 |
| 500 | 服务内部错误，请查看详细的错误原因 |
请求示例演示:
请求路径：
https://api.cloud.pkpm.cn/bimserver/user/v3/users/136/labels
