更新时间:2023-08-23 GMT+08:00
分享

认证登录获取授权码

功能介绍

用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带授权码code参数。

URI

GET /api/v1/oauth2/authorize

表1 Query参数

参数

是否必选

参数类型

描述

client_id

String

应用标识,注册应用后,分配的ClientId。

redirect_uri

String

回调地址,表示应用接收OneAccess授权码的地址。地址可以是注册应用时填写的回调地址,也可以是注册应用时填写的回调地址的域名。

response_type

String

授权类型,固定值:code。

scope

String

授权范围,固定值:openid。

state

String

应用的状态值。可用于防止CSRF攻击,成功授权后回调应用时会原样带回,应用用它校验认证请求与回调请求的对应关系。可以包含字母和数字。

请求参数

响应参数

状态码: 302

表2 响应Header参数

参数

参数类型

描述

Location

String

认证登录成功,重定向地址。例:https://example.com?code=z2D...&state=test

请求示例

获取OIDC授权码。授权类型为固定值code,配置应用注册时生成的clientId,成功授权后的回调地址为https://example.com,授权范围为固定值openid。

GET https://{domain_name}/api/v1/oauth2/authorize?response_type=code&client_id=cU0L3GsEq1vuOJ5iQrRSu5AyPnKL8...&redirect_uri=https://example.com&scope=openid&state=test

响应示例

状态码

状态码

描述

302

用户未登录,跳转用户登录页面。用户已登录,携带授权码重定向到redirect_uri地址。例:https://example.com?code=z2D...&state=test。

错误码

请参见错误码

相关文档