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

OAuth获取用户信息

用于web端OAuth登录认证场景,SaaS服务器换取用户token后,根据用户token获取用户基础信息。

URI

GET /api/v1/oauth2/userinfo

请求参数

表1 请求Header

参数

是否必选

参数类型

描述

Accept

String

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

Authorization

String

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

请求示例

GET {domain_name}/api/v1/oauth2/userinfo 
 
Authorization: Bearer ****** 
Accept: application/json

响应参数

表2 状态码

状态码

描述

200

请求成功。

401

认证失败。

表3 响应Body参数

参数

参数类型

描述

id

String

用户ID

userName

String

用户名

name

String

姓名

email

String

邮箱地址

mobile

String

手机号

error

String

错误类型。

error_description

String

错误描述。

role

String

角色

organizationName

String

组织名称

userId

String

用户id

organizationCode

String

组织编码

projectName

String

租户名称

tenant

String

租户id

响应示例

状态码: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" 
}

相关文档