密码（password）均为SHA256摘要，禁止明文传输
-
路径: /authorize?client_id=xxxxxx&response_type=code&redirect_uri=xxxxxx&state=xxxxxx
-
方式：get
-
参数说明
{ "client_id": "xxxxxx", // 客户端ID "response_type": "code", // 固定值，认证码模式为code "redirect_uri": "xxxxxx", // 认证成功重定向uri，后台匹配验证，只设一个可以不传，支持正则配置 "state": "xxxxxx" // 若有则原样返回 } -
重定向返回 redirect_uri
redirect_uri?code=xxxxx-xxxx-xxxx-xxxxx&state=xxxxxx
如已单点登录，则无需再登录直接重定向返回：redirect_uri?code=xxxxx-xxxx-xxxx-xxxxx&state=xxxxxx -
根据 code 获取 Token
- 路径：/token
- 方式：post
- 参数说明
{ "client_id": "xxxxxx", // 客户端ID "grant_type": "authorization_code", // 固定值，认证码模式为authorization_code "code": "xxxxxx", // 上一步返回的code "client_secret": "xxxxx-xxxx-xxxx-xxxxx", // 授权给客户端的密钥 "redirect_uri": "xxxxxx" // 与之前的redirect_uri须一致 } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 400, // 状态码 "message": "无效的客户端 or 未授权的grantType or code错误/不能为空 or client_secret错误 or redirect_uri不匹配" }
- 路径: /authorize?client_id=xxxxxx&response_type=token&redirect_uri=xxxxxx&state=xxxxxx
- 方式：get
- 参数说明
{ "client_id": "xxxxxx", // 客户端ID "response_type": "token", // 固定值，认证码模式为token "redirect_uri": "xxxxxx", // 认证成功重定向uri，后台匹配验证，只设一个可以不传，支持正则配置 "state": "xxxxxx" // 若有则原样返回 } - 重定向返回 redirect_uri
redirect_uri?access_token=xxxxx-xxxx-xxxx-xxxxx&expires_in=xxx&state=xxxxxx
如已单点登录，则无需再登录直接重定向返回：redirect_uri?access_token=xxxxx-xxxx-xxxx-xxxxx&expires_in=xxx&state=xxxxxx
- 路径: /token
- 方式：post
- 参数说明
{ "client_id": "xxxxxx", // 客户端ID "grant_type": "password", // 固定值，密码模式为password "username": "xxxxxx", // 用户名 "password": "xxxxxx" // 密码 } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 401, // 状态码 "message": "错误信息" }状态码 错误信息 备注 401 账号或密码错误 账号或密码错误 406 账号被锁定，请申诉解锁 账号被锁定，请申诉解锁 406 密码过期，必须修改密码 密码过期，必须修改密码
- 路径: /token
- 方式：post
- 参数说明
{ "client_id": "xxxxxx", // 客户端ID "grant_type": "client_credentials", // 固定值，凭证模式为client_credentials "client_secret": "xxxxxx" // 客户端密钥 } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 401, // 状态码 "message": "client_secret错误" }
-
路径: /authorize?client_id=xxxxxx&response_type=code&redirect_uri=xxxxxx&state=xxxxxx&code_challenge=xxxxxx
-
方式：get
-
参数说明
{ "client_id": "xxxxxx", // 客户端ID "response_type": "code", // 固定值，认证码模式为code "redirect_uri": "xxxxxx", // 认证成功重定向uri，后台匹配验证，只设一个可以不传，支持正则配置 "state": "xxxxxx", // 若有则原样返回 "code_challenge": "xxxxxx" // PKCE码，随机字符串SHA256摘要后BASE64 } -
重定向返回 redirect_uri
redirect_uri?code=xxxxx-xxxx-xxxx-xxxxx&state=xxxxxx
如已单点登录，则无需再登录直接重定向返回：redirect_uri?code=xxxxx-xxxx-xxxx-xxxxx&state=xxxxxx -
根据 code 获取 Token
- 路径：/token
- 方式：post
- 参数说明
{ "client_id": "xxxxxx", // 客户端ID "grant_type": "authorization_code", // 固定值，认证码模式为authorization_code "code": "xxxxxx", // 上一步返回的code "redirect_uri": "xxxxxx", // 与之前的redirect_uri须一致 "code_verifier": "xxxxxx" // 生成PKCE码的原始字符串 } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 400, // 状态码 "message": "无效的客户端 or 未授权的grantType or code错误/不能为空 or code_verifier错误 or redirect_uri不匹配" }
- 路径: /api/captcha
- 方式：post
- 参数：
{ "client_id": "xxxxxx", // 客户端ID "mobile": "xxxxxxxxxxx" // 手机号码 } - 响应信息
正常返回：异常返回：{ "authorizeId": "xxxxx-xxxx-xxxx-xxxxx", // 请求ID "target": "xxxxxxxxxxx" // 验证码接收目标，手机或邮件 }{ "code": 400, // 状态码 "message": "xxxxxxxxxxx" // 异常信息 }状态码 响应体 备注 400 参数不合法 client_id 或者 mobile 错误 400 用户未注册 500 发送验证码失败
- 路径: /api/token
- 方式：post
- 参数：
{ "authorize_id": "xxx", //第一步返回的请求ID "mobile": "xxxxxxxxxxx", //手机号码 "captcha": "xxx" //手机验证码 } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 400, // 状态码 "message": "验证码已失效 or 手机号码不匹配 or 验证码错误 or 无效的客户端" }
- 路径: /token
- 方式：post
- 参数：
{ "client_id": "xxxxxx", //客户端ID "grant_type": "password", //固定值 "username": "xxx", //账号 "password": "xxx" //密码 } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 401, // 状态码 "message": "错误信息" }状态码 错误信息 备注 400 无效的客户端 or 未授权的 grantType or 账号和密码不能为空 401 账号或密码错误 账号或密码错误 406 账号被锁定，请申诉解锁 账号被锁定，请申诉解锁 406 密码过期，必须修改密码 密码过期，必须修改密码
- 路径: /api/jwtUser
- 方式：get
- 参数：
- 方式：Bearer Token
- 位置：HTTP HEAD
- 参数名：Authorization
- 示例：Authorization: "Bearer xxxxx-xxxx-xxxx-xxxxx"
- 响应信息
正常返回：异常返回：{ "userId": "xxxxxx", // 用户ID "username": "xxxxx", // 登录名 "nickname": "xxxxx", // 用户昵称 "roles": [], // 用户角色 "clientId": "xxxxx" // 客户端ID }{ "code": 401, // 状态码 "message": "无效的access_token or 账号不存在" }
- 路径: /token
- 方式：post
- 参数：
{ "client_id": "xxxxxx", // 客户端ID "grant_type": "refresh_token", // 固定值 "refresh_token": "xxxxx-xxxx-xxxx-xxxxx" // refresh_token } - 响应信息
正常返回：异常返回：{ "access_token": "xxxxx-xxxx-xxxx-xxxxx", // access_token "refresh_token": "xxxxx-xxxx-xxxx-xxxxx", // refresh_token "expires_in": 86400 // access_token失效时间，单位秒 }{ "code": 401, // 状态码 "message": "错误信息" }状态码 错误信息 备注 400 无效的客户端 or 未授权的 grantType or refresh_token 不能为空 401 无效的 refresh_token
前端获取Token才能实现单点登录
- 路径: /logout?redirect_uri=xxxxxx
- 方式：get
- 参数：
{ "redirect_uri": "xxxxxx" // 单点登出后重定向页面，不传为默认为'/' }