OAuth API.

概览

OAuth API.

版本信息

版本 : 2.0.0

URI scheme

域名 : ${domainId}.auth.aliyunpds.com
协议 : HTTPS
基础路径 : /v2

API

GET /v2/oauth/authorize

描述

发起OAuth2.0鉴权流程

请求参数

参数位置 : query参数字段 : AuthorizeRequest

请求样例

https://hz0.auth.aliyunpds.com/v2/oauth/authorize?client_id=xxx&redirect_uri=https%3A%2F%2Fxxx.com&response_type=code

响应

HTTP代码	说明	类型
302	重定向到认证服务	无内容
400	请求参数无效	InvalidParameterError
403	无权限	ForbiddenError
500	内部错误	InternalErrorError

POST /v2/oauth/token

描述

获取token

请求参数

参数位置 : body参数格式 : application/x-www-form-urlencoded参数字段 : TokenRequest

请求Body样例

# 通过code获取access_token
client_id=xxx&client_secret=xxx&code=xxxx&grant_type=code&redirect_uri=https%3A%2F%2Fxxx.com
# 通过refresh_token获取access_token
client_id=xxx&client_secret=xxx&refresh_token=xxxx&grant_type=refresh_token&redirect_uri=https%3A%2F%2Fxxx.com
# 通过jwt获取access_token
client_id=xxx&client_secret=xxx&assertion=ak******asd==&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

相关链接：通过JWT方式接入指南

响应

HTTP代码	说明	类型
200	请求成功	AccessTokenResponse
400	1. 请求参数无效. 2. 请求body是无效的json格式	InvalidParameterError
403	无权限	ForbiddenError
500	内部错误	InternalErrorError

AuthorizeRequest

名称	说明	类型
client_id 必填	Client ID, 此处填写创建App时返回的AppID 样例 : `"aksjoiajsoias"`	string
login_type 可选	鉴权方式，目前支持default,ding,ram 默认值 : `"ding"` 样例 : `"ding"`	string
redirect_uri 必填	回调地址, 此处填写创建App时填写的回调地址样例 : `"https://app.com/callback"`	string
response_type 必填	返回类型, 可填写code,token 样例 : `"code"`	string
scope 可选	申请的权限列表, 默认为所有权限	< string > array
state 可选	用户自定义字段，会在鉴权成功后的callback带回样例 : `"string"`	string

TokenRequest

名称	说明	类型
assertion 可选	JWT方式授权需要传此参数，传入JWT签名的声明，用于更换accessToken 样例 : `"ak******asd=="`	string
client_id 必填	Client ID, 此处填写创建App时返回的AppID 样例 : `"aksjoiajsoias"`	string
client_secret 可选	Client ID, 此处填写创建App时返回的AppSecret 样例 : `"alsdklajdkxlawalwknq"`	string
code 可选	认证后回调参数中的code 样例 : `"cjajksadhw"`	string
grant_type 必填	通过哪种方式获取accessToken，可选值：refresh_token, authorization_code, urn:ietf:params:oauth:grant-type:jwt-bearer 样例 : `"authorization_code"`	enum
redirect_uri 可选	回调地址, 此处填写创建App时填写的回调地址，OAuth方式登录时需要传入样例 : `"https://app.com/callback"`	string
refresh_token 可选	刷新accessToken使用的refreshToken 样例 : `"aksbcjhwhq"`	string