文档首页/ 应用身份管理服务 OneAccess/ API参考/ API/ 管理类接口/ 用户管理/ 根据用户名查询用户详情
更新时间：2024-08-30 GMT+08:00
查看PDF
分享

根据用户名查询用户详情

功能介绍

根据用户名查询用户详情。

接口约束

无

URI

POST /api/v2/tenant/users/user-by-username

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

Authorization

是

String

认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。
表2 请求Body参数

参数

是否必选

参数类型

描述

user_name

是

String

用户名称。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

user_id

String

用户id。

org_id

String

用户所属组织。

user_name

String

用户名。

name

String

姓名。

mobile

String

手机号。

email

String

邮箱。

pwd_must_modify

Boolean

首次登录是否强制修改密码。

pwd_change_at

String

密码修改时间

created_at

String

创建时间。

updated_at

String

最后一次修改时间。

disabled

Boolean

是否禁用。

grade

Integer

可信等级。

locked

String

是否锁定。

extension

Object

自定义扩展属性。

user_org_relation_list

Array of UserOrgRelationListResult objects

用户组织关系集合。
表4 UserOrgRelationListResult

参数

参数类型

描述

org_id

String

组织id。

relation_type

String

关系类型。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误编号。

error_msg

String

错误详情。

请求示例

根据用户名查询用户详情，用户名zhangsan。

POST https://{domain_name}/api/v2/tenant/users/user-by-username

{
  "user_name" : "zhangsan"
}

响应示例

状态码： 200

请求成功。

{
  "user_id" : "20220413165737132-3BA0-91FCA2CB7",
  "org_id" : "20220117125622909-9346-35755733F",
  "user_name" : "zhangsan",
  "name" : "zhangsan",
  "mobile" : "12345678901",
  "email" : "zhangsan@example.com",
  "pwd_must_modify" : true,
  "pwd_change_at" : "2022-04-14 10:14:01.988",
  "created_at" : "2022-04-13 16:57:36.532",
  "updated_at" : "2022-04-14 10:14:01.979",
  "disabled" : false,
  "grade" : 1,
  "locked" : false,
  "extension" : { },
  "user_org_relation_list" : [ {
    "org_id" : "20220117125622909-9346-35755733F",
    "relation_type" : 1
  }, {
    "org_id" : "20220415103506608-AF59-5CC9081B9",
    "relation_type" : 0
  } ]
}

状态码

状态码

描述

200

请求成功。

400

参数无效。

错误码

请参见错误码。

父主题： 用户管理

相关文档