更新时间:2024-08-30 GMT+08:00
分享

获取用户信息

功能介绍

获取用户信息。

接口约束

URI

GET /api/v1/oauth2/userinfo

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

认证凭据,值:Bearer {access_token}。

Accept

String

接收响应类型,值:application/json。

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

id

String

用户ID

userName

String

用户名

name

String

姓名

email

String

邮箱地址

mobile

String

手机号

状态码: 401

表3 响应Body参数

参数

参数类型

描述

error

String

错误类型。

error_description

String

错误描述。

请求示例

基于access_token 查询用户信息。

GET https://{domain_name}/api/v1/oauth2/userinfo

Authorization: Bearer b7e1fda8-33ce-432c-9b97-7ff035fac...
Accept: application/json

响应示例

状态码: 200

请求成功。

{
  "id" : "20201029190841785-CB37-8BD36B...",
  "name" : "test",
  "userName" : "test",
  "mobile" : "12345678901",
  "email" : "123@example.com"
}

状态码: 401

认证失败。

{
  "error" : "unauthorized",
  "error_description" : "Full authentication is required to access this resource"
}

状态码

状态码

描述

200

请求成功。

401

认证失败。

错误码

请参见错误码

相关文档