GET 用户详情
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/client/{id} |
| 所属业务 | 用户管理 |
| 来源模块/系统 | 用户管理 |
| 认证方式 | Bearer Token(管理员令牌) |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
用户详情
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 用户ID |
成功响应
正在加载示例…失败响应 400:请求参数或业务校验失败
正在加载示例…失败响应 401:未认证或登录已失效
正在加载示例…失败响应 403:无权执行当前操作
正在加载示例…失败响应 404:接口或业务资源不存在
正在加载示例…失败响应 500:服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.client | object | 否 | — | 用户 |
data.client.id | integer(int32) | 否 | — | 用户ID |
data.client.username | string | 否 | — | 姓名 |
data.client.email | string | 否 | — | 邮箱 |
data.client.phone_code | integer(int32) | 否 | — | 国际电话区号 |
data.client.phone | string | 否 | — | 手机号 |
data.client.company | string | 否 | — | 公司 |
data.client.country_id | integer(int32) | 否 | — | 国家ID |
data.client.address | string | 否 | — | 地址 |
data.client.language | string | 否 | — | 语言 |
data.client.notes | string | 否 | — | 备注 |
data.client.status | integer(int32) | 否 | — | 状态 0禁用 1正常 |
data.client.register_time | integer(int32) | 否 | — | 注册时间 |
data.client.last_login_time | integer(int32) | 否 | — | 上次登录时间 |
data.client.last_login_ip | string | 否 | — | 上次登录IP |
data.client.credit | string | 否 | — | 余额 |
data.client.consume | string | 否 | — | 消费 |
data.client.refund | string | 否 | — | 退款 |
data.client.withdraw | string | 否 | — | 提现 |
data.client.host_num | integer(int32) | 否 | — | 产品数量 |
data.client.host_active_num | integer(int32) | 否 | — | 已激活产品数量 |
data.client.login_logs | [object] | 否 | — | 登录记录 |
data.client.login_logs[].ip | string | 否 | — | IP |
data.client.login_logs[].login_time | integer(int32) | 否 | — | 登录时间 |
data.client.certification | boolean | 否 | — | 是否实名认证 true是 false否 |
data.client.certification_detail | object | 否 | — | 实名认证详情 当certification为true时才有此字段 |
data.client.certification_detail.company | object | 否 | — | 企业实名认证详情 |
data.client.certification_detail.company.card_name | string | 否 | — | 认证姓名 |
data.client.certification_detail.company.card_type | integer(int32) | 否 | — | 证件类型 1身份证 2港澳通行证 3台湾通行证 4港澳居住证 5台湾居住证 6海外护照 7中国以外驾照 8其他 |
data.client.certification_detail.company.card_number | string | 否 | — | 证件号 |
data.client.certification_detail.company.phone | string | 否 | — | 手机号 |
data.client.certification_detail.company.status | integer(int32) | 否 | — | 状态 1已认证 2未通过 3待审核 4已提交资料 |
data.client.certification_detail.company.company | string | 否 | — | 公司名称 |
data.client.certification_detail.company.company_organ_code | string | 否 | — | 公司代码 |
data.client.certification_detail.company.img_one | string | 否 | — | 身份证正面 |
data.client.certification_detail.company.img_two | string | 否 | — | 身份证反面 |
data.client.certification_detail.company.img_three | string | 否 | — | 营业执照 |
data.client.certification_detail.company.auth_fail | string | 否 | — | 失败原因 |
data.client.certification_detail.person | object | 否 | — | 个人实名认证详情 |
data.client.certification_detail.person.card_name | string | 否 | — | 认证姓名 |
data.client.certification_detail.person.card_type | integer(int32) | 否 | — | 证件类型 1身份证 2港澳通行证 3台湾通行证 4港澳居住证 5台湾居住证 6海外护照 7中国以外驾照 8其他 |
data.client.certification_detail.person.card_number | string | 否 | — | 证件号 |
data.client.certification_detail.person.phone | string | 否 | — | 手机号 |
data.client.certification_detail.person.status | integer(int32) | 否 | — | 状态 1已认证 2未通过 3待审核 4已提交资料 |
data.client.certification_detail.person.img_one | string | 否 | — | 身份证正面 |
data.client.certification_detail.person.img_two | string | 否 | — | 身份证反面 |
data.client.certification_detail.person.img_three | string | 否 | — | 营业执照 |
data.client.certification_detail.person.auth_fail | string | 否 | — | 失败原因 |
data.client.set_operate_password | boolean | string | 否 | — | 是否设置了操作密码 |
data.client.receive_sms | integer(int32) | 否 | — | 接收短信 0关闭 1开启 |
data.client.receive_email | integer(int32) | 否 | — | 接收邮件 0关闭 1开启 |
data.client.oauth | [string] | 否 | — | 关联的三方登录类型 |
data.client.mp_weixin_notice | integer(int32) | 否 | — | 微信公众号关注状态 0未关注 1已关注 |
data.client.freeze_credit | number(double) | string | 否 | — | 冻结余额 |
data.client.notice_open | integer(int32) | 否 | — | — |
data.client.notice_method | string | 否 | — | — |
data.client.credit_remind | integer(int32) | 否 | — | — |
data.client.credit_remind_amount | string | 否 | — | — |
data.client.total_credit | string | 否 | — | — |
data.client.customfield | object | 否 | — | — |
data.client.customfield.idcsmart_client_level | object | 否 | — | — |
data.client.customfield.idcsmart_client_level.id | integer(int32) | 否 | — | — |
data.client.customfield.idcsmart_client_level.list | [object] | 否 | — | — |
data.client.customfield.idcsmart_client_level.list[].id | integer(int32) | 否 | — | — |
data.client.customfield.idcsmart_client_level.list[].name | string | 否 | — | — |
data.client.customfield.idcsmart_client_level.list[].notes | string | 否 | — | — |
data.client.customfield.idcsmart_client_level.list[].background_color | string | 否 | — | — |
data.client.customfield.idcsmart_client_level.list[].role | string | 否 | — | — |
失败状态码 400、401、403、404、500 共用以下结构:
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |