You need to enable JavaScript to run this app.
导航

OAuth2.0单点登录的接口标准

最近更新时间2023.07.11 11:33:51

首次发布时间2023.07.11 11:33:51

OAuth登录过程中,火山引擎支持授权码模式的OAuth认证,需要通过企业身份系统的授权端点获取授权码、通过Token端点获取AccessToken、通过UserInfo端点获取用户信息。
OAuth登录基本流程见:OAuth基本流程

其中获取授权码通过URL参数返回,获取AccessToken和用户信息的接口标准分别如下所示:

access_token 接口标准

请求信息
请求方式HTTP POST
请求类型application/x-www-form-urlencoded
请求地址${access_token URL}
Request
client_id客户端id
client_secret客户端应用密钥
grant_type授权方式,固定为授权码 authorization_code
redirect_uri登录流程中的redirect_uri参数
code授权码
Response
响应类型application/json

响应示例

{ 
     "access_token": "", 
     "token_type": "Bearer", 
     "refresh_token": "", 
     "expire_in": 3600 
 } 

user_info 接口标准

请求信息
请求方式HTTP GET
请求类型application/x-www-form-urlencoded
请求地址${user_info URL}
Header
AuthorizationBearer ${access_token}
Response
响应类型application/json

响应示例

{
    "user": {
        "name": ""
    }
}
  • 请注意,user_info 返回结果基于json结构即可。返回的格式影响在访问控制中配置Oauth身份提供商时的用户映射规则配置:
    • 如果user_info的返回格式为多层的json结构,需要映射的企业员工信息字段(例如为name字段)在内层,参考上方示例,则用户映射规则内取user.name即可。
      alt
    • 如果user_info的返回格式为单层的json结构,需要映射的企业员工信息字段(例如为name字段)在最外层,则用户映射规则内取name即可。
      alt