OAuth 2.0 标准授权回调 API
功能介绍
OAuth2重定向回调端点,用于在用户同意/拒绝后接收授权结果。
URI
GET /v1/oauth2/callback/{credential_provider_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| credential_provider_id | 是 | String | 参数解释: 凭证提供商的唯一标识符。 约束限制: 不涉及。 取值范围: UUID格式。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| code | 否 | String | 参数解释: OAuth2.0标准授权码 - 一次性使用、短期有效的令牌,用于交换访问令牌。仅在授权成功时存在。 约束限制: 不涉及。 取值范围: 长度为1~8192个字符。 默认取值: 不涉及。 |
| state | 是 | String | 参数解释: OAuth2.0标准CSRF保护状态 - 不透明字符串,原始请求状态的回显。成功和错误时都存在。 约束限制: 不涉及。 取值范围: 长度为1~4096个字符。 默认取值: 不涉及。 |
| error | 否 | String | 参数解释: OAuth2.0标准错误码 - 仅在授权失败(拒绝/过期/无效)时存在。例如:access_denied、invalid_scope、server_error。 约束限制: 不涉及。 取值范围: 长度为1~128个字符。 默认取值: 不涉及。 |
| error_description | 否 | String | 参数解释: OAuth2.0标准错误描述 - 人类可读的错误信息,与error参数配对,URL编码以安全传输。 约束限制: 不涉及。 取值范围: 长度为1~2048个字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
无
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 302 | 始终重定向到预配置的资源oauth2_return_url,并在查询参数中携带授权结果(成功:code+state | 错误:error+error_description+state) |
错误码
请参见错误码。