调用该接口查询统一身份。

路径 /user/account/identity/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
loginId String 4***65 外标的ID。
loginSource String openAccount 账号来源类型(openAccount)。
phone String 13833333**** 手机号码。
email String xxx@qq.com 邮箱地址。
opType Int 1 1(表示根据loginId & loginSouce),2(表示根据手机号码),3(表示根据邮箱),其他值(表示非法取值)。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

phone String

手机号码。

identityId String

账户的统一身份ID。

nickName String

用户昵称。

loginId String

外标ID。

avatarUrl String

头像地址。

loginName String

登录名称。

loginSource String

账号来源。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"loginId": "4***65",
		"loginSource": "openAccount",
		"phone": "13833333****",
		"email": "xxx@qq.com",
		"opType":1
	}
}

正常返回示例

JSON 格式

{
  "id": "8d1a665e-ce92-45bf-add8-99d2e818****",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "identityId": "5053opf5d4a333333324473f5db0e7****",
    "loginId": "4***65",
    "loginSource": "openAccount",
    "modifier": "system",
    "nickName": "ktt",
    "phone": "13833333****",
    "loginName": "tester"
  }
}

异常返回示例

JSON 格式

{
  "id":"8d1a665e-ce92-45bf-add8-99d2e818****", 
  "code": 460,
  "message": "request parameter error.",
  "localizedMsg":null,
  "data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 460 identityId is blank 需要注销的账号不存在
200 500 Bad Request 调用网关失败
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 2477 import thirdaccount failed 导入三方账号失败
200 460 thirdAccountMetaList is blank 三方账号列表为空
200 460 identityId is blank 需要注销的账号不存在
200 500 Bad Request 调用网关失败
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 入参不正确
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 2486 access refresh token expired accessToken或者 refreshToken已经过期
200 460 request parameter error. 请求参数错误
200 401 app key tenant id not match app key tenant id not match
200 2453 app not exist appkey对应的应用不存在
200 2486 access refresh token expired accessToken或者 refreshToken已经过期
200 460 request parameter error. 请求参数错误
200 401 request auth error. appKey与统一身份ID对应的租户不同
200 2453 app not exist appKey对应的应用不存在
200 2478 this phone has registered 修改后的手机号已经存在
200 2442 employee is not exist 统一身份id不存在
200 500 Bad Request api不存在
200 2405 identity is not existed 公司未初始化
200 2441 employee is already existed 该手机号对应的员工已经存在
200 4028 login name not exist 账号不存在
200 4004 invalid mobile 手机号格式不对
200 2478 this phone has registered 修改后的手机号已经存在
200 2442 employee is not exist 统一身份id不存在
200 460 pageSize should between 1-50 每页的数量在1-50之间
200 460 companyId or phone is blank 入参中公司id和手机号不全
200 2405 identity is not existed 账号不存在
200 2411 oldpassword check faild 修改密码异常
200 403 request forbidden. 请求被禁止
200 460 identityIds need between 1-50 入参错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 入参错误
200 460 request parameter error 入参错误