文档首页/ 组织成员账号 OrgID/ API参考/ API/ 基于OAuth的应用认证集成/ 获取用户信息
更新时间：2024-08-02 GMT+08:00
查看PDF
分享

获取用户信息

功能介绍

获取用户信息。

URI

GET /orgid/openapi/v1/oauth2/userinfo

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-OrgID-Authorization

是

String

用户访问凭证，即Bearer {access_token}。

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

tenant_name

String

租户名称。

tenant

String

租户code，即企业code。

name

String

用户名。

mobile

String

手机号。

user_name

String

用户登录账号。

user_id

String

用户外部id。

employee_code

String

成员工号。

role

String

角色，枚举：user或admin。

状态码： 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error

String

错误码（兼容原开放接口字段）。

error_description

String

错误描述（兼容原开放接口字段）。

状态码： 401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error

String

错误码（兼容原开放接口字段）。

error_description

String

错误描述（兼容原开放接口字段）。

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error

String

错误码（兼容原开放接口字段）。

error_description

String

错误描述（兼容原开放接口字段）。

请求示例

GET https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/userinfo
--header 'Authorization': Bearer 0s2tzzP4K7ragzUrj-***GqQDxuv9S3vDHYtFCb5GxcDv

响应示例

状态码： 200

正常响应。

{
  "tenant_name": "801test",
  "role": "admin",
  "user_id": "1008600000169057387",
  "user_name": "hid_u_-9utkbz24lphe",
  "name": "138******37",
  "mobile": "008613800000037",
  "tenant": "9190086000000010904",
  "employee_code": "00001"
}

状态码

状态码

描述

200

正常响应。

400

参数错误响应。

401

权限错误响应。

500

系统错误响应。

错误码

请参见错误码。

相关文档