获取三方授权信息
POST/auth/v1/provider/token
获取三方服务的授权信息,如通过oauth登录,获取oauth client对应的授权用户信息生成一个provider_token, 调用身份源登录接口需要
Request
Query Parameters
client_id string
应用对应的客户端id,默认为环境id,可以不传
Header Parameters
x-device-id stringrequired
设备id
- application/json
Body
provider_id 身份源id, 如wx_open,或小程序appid (string)required
provider_redirect_uri 身份源回调地址 (string)
provider_code 第三方系统获取的登录code, 用来换取用户身份 (string)
Responses
- 200
- 500
A successful response.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
provider_token 如果不启用自动注册, 则返回 provider_token, 用于进一步处理,例如:通过手机号等。 (string)
expires_in int32
provider_profile object
provider_id 身份源id (string)
sub 主ID, 标识用户唯一标识 (string)
name 姓名 (string)
picture 头像 (string)
email 邮箱 (string)
phone_number 手机号 (string)
gender 性别 (string)
locale 地区 (string)
url 邮箱 (string)
groups string[]
sub_id sub_id 如果客户选需要SLO,可能需要返回sub_id, 可以参考:urn:oasis:names:tc:SAML:attribute:subject-id (string)
token provider 返回的 token,比如:oauth 模式下,该token为 refresh_token (string)
at_hash at hash of provider profile (string)
meta object
object
property name* string
raw 三方信息原文 (string)
provider 身份源类型 (string)
{
"provider_token": "string",
"expires_in": 0,
"provider_profile": {
"provider_id": "string",
"sub": "string",
"name": "string",
"picture": "string",
"email": "string",
"phone_number": "string",
"gender": "string",
"locale": "string",
"url": "string",
"groups": [
"string"
],
"sub_id": "string",
"token": "string",
"at_hash": "string",
"meta": {},
"raw": "string",
"provider": "string"
}
}
An unexpected error response.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
error 错误信息 (string)
error_code int32
error_description 错误描述 (string)
{
"error": "string",
"error_code": 0,
"error_description": "string"
}
Loading...