序列化表格

程序包 cn.dev33.satoken.oauth2.config

类 cn.dev33.satoken.oauth2.config.SaOAuth2OidcConfig

class SaOAuth2OidcConfig extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

idTokenTimeout

long idTokenTimeout

idToken 有效期（单位秒） 默认十分钟

iss

String iss

iss 值，如不配置则自动计算

类 cn.dev33.satoken.oauth2.config.SaOAuth2ServerConfig

class SaOAuth2ServerConfig extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

accessTokenTimeout

long accessTokenTimeout

Access-Token 保存的时间(单位：秒) 默认两个小时

clients

Map<String,SaClientModel> clients

client 列表

clientTokenTimeout

long clientTokenTimeout

Client-Token 保存的时间(单位：秒) 默认两个小时

codeTimeout

long codeTimeout

Code授权码 保存的时间(单位：秒) 默认五分钟

confirmView

SaOAuth2ConfirmViewFunction confirmView

OAuth-Server端：确认授权时返回的View

doLoginHandle

SaOAuth2DoLoginHandleFunction doLoginHandle

OAuth-Server端：登录函数

enableAuthorizationCode

Boolean enableAuthorizationCode

是否打开模式：授权码（Authorization Code）

enableClientCredentials

Boolean enableClientCredentials

是否打开模式：凭证式（Client Credentials）

enableImplicit

Boolean enableImplicit

是否打开模式：隐藏式（Implicit）

enablePassword

Boolean enablePassword

是否打开模式：密码式（Password）

hideStatusField

Boolean hideStatusField

是否在返回值中隐藏默认的状态字段 (code、msg、data)

higherScope

String higherScope

指定高级权限，多个用逗号隔开

isNewRefresh

Boolean isNewRefresh

是否在每次 Refresh-Token 刷新 Access-Token 时，产生一个新的 Refresh-Token

lowerClientTokenTimeout

long lowerClientTokenTimeout

Lower-Client-Token 保存的时间(单位：秒) 默认为 -1，代表延续 Client-Token 有效期

lowerScope

String lowerScope

指定低级权限，多个用逗号隔开

mode4ReturnAccessToken

Boolean mode4ReturnAccessToken

模式4是否返回 AccessToken 字段

notLoginView

SaOAuth2NotLoginViewFunction notLoginView

OAuth-Server端：未登录时返回的View

oidc

SaOAuth2OidcConfig oidc

oidc 相关配置

openidDigestPrefix

String openidDigestPrefix

默认 openid 生成算法中使用的摘要前缀

refreshTokenTimeout

long refreshTokenTimeout

Refresh-Token 保存的时间(单位：秒) 默认30 天

程序包 cn.dev33.satoken.oauth2.data.model

类 cn.dev33.satoken.oauth2.data.model.AccessTokenModel

class AccessTokenModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

accessToken

String accessToken

Access-Token 值

clientId

String clientId

应用id

expiresTime

long expiresTime

Access-Token 到期时间

extraData

Map<String,Object> extraData

扩展数据

loginId

Object loginId

账号id

refreshExpiresTime

long refreshExpiresTime

Refresh-Token 到期时间

refreshToken

String refreshToken

Refresh-Token 值

scopes

List<String> scopes

授权范围

tokenType

String tokenType

Token 类型

类 cn.dev33.satoken.oauth2.data.model.ClientTokenModel

class ClientTokenModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

clientId

String clientId

应用id

clientToken

String clientToken

Client-Token 值

expiresTime

long expiresTime

Client-Token 到期时间

extraData

Map<String,Object> extraData

扩展数据

scopes

List<String> scopes

授权范围

tokenType

String tokenType

Token 类型

类 cn.dev33.satoken.oauth2.data.model.CodeModel

class CodeModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

clientId

String clientId

应用id

code

String code

授权码

loginId

Object loginId

对应账号id

redirectUri

String redirectUri

重定向的地址

scopes

List<String> scopes

授权范围

类 cn.dev33.satoken.oauth2.data.model.RefreshTokenModel

class RefreshTokenModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

clientId

String clientId

应用id

expiresTime

long expiresTime

Refresh-Token 到期时间

extraData

Map<String,Object> extraData

扩展数据

loginId

Object loginId

对应账号id

refreshToken

String refreshToken

Refresh-Token 值

scopes

List<String> scopes

授权范围

程序包 cn.dev33.satoken.oauth2.data.model.loader

类 cn.dev33.satoken.oauth2.data.model.loader.SaClientModel

class SaClientModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

accessTokenTimeout

long accessTokenTimeout

单独配置此Client：Access-Token 保存的时间(单位秒) [默认取全局配置]

allowGrantTypes

List<String> allowGrantTypes

应用允许的所有 grant_type

allowRedirectUris

List<String> allowRedirectUris

应用允许授权的所有 redirect_uri

clientId

String clientId

应用id

clientSecret

String clientSecret

应用秘钥

clientTokenTimeout

long clientTokenTimeout

单独配置此Client：Client-Token 保存的时间(单位秒) [默认取全局配置]

contractScopes

List<String> contractScopes

应用签约的所有权限

isNewRefresh

Boolean isNewRefresh

单独配置此Client：是否在每次 Refresh-Token 刷新 Access-Token 时，产生一个新的 Refresh-Token [默认取全局配置]

lowerClientTokenTimeout

long lowerClientTokenTimeout

单独配置此Client：Lower-Client-Token 保存的时间(单位：秒) [默认取全局配置]

refreshTokenTimeout

long refreshTokenTimeout

单独配置此Client：Refresh-Token 保存的时间(单位秒) [默认取全局配置]

程序包 cn.dev33.satoken.oauth2.data.model.oidc

类 cn.dev33.satoken.oauth2.data.model.oidc.IdTokenModel

class IdTokenModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

acr

String acr

身份验证上下文类引用

amr

String amr

身份验证方法参考

aud

String aud

必填：客户端标识符，clientId，例如：s6BhdRkqt3

authTime

long authTime

用户认证时间，10位时间戳，例如：1723339988

azp

String azp

授权方 - 签发 ID 令牌的一方，如果存在，它必须包含此方的 OAuth 2.0 客户端 ID。

exp

long exp

必填：令牌到期时间，10位时间戳，例如：1723341795

extraData

Map<String,Object> extraData

扩展数据

iat

long iat

必填：签发此令牌的时间，10位时间戳，例如：1723339995

iss

String iss

必填：发行者标识符，例如：https://server.example.com

nonce

String nonce

随机数，客户端提供，防止重放攻击，例如：e9a3f4d9

sub

Object sub

必填：用户标识符，用户id，例如：10001

程序包 cn.dev33.satoken.oauth2.data.model.request

类 cn.dev33.satoken.oauth2.data.model.request.ClientIdAndSecretModel

class ClientIdAndSecretModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

clientId

String clientId

应用id

clientSecret

String clientSecret

应用秘钥

类 cn.dev33.satoken.oauth2.data.model.request.RequestAuthModel

class RequestAuthModel extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

clientId

String clientId

应用id

loginId

Object loginId

对应的账号id

redirectUri

String redirectUri

待重定向URL

responseType

String responseType

授权类型, 非必填

scopes

List<String> scopes

授权范围

state

String state

状态标识, 可为null

程序包 cn.dev33.satoken.oauth2.exception

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2AccessTokenException

class SaOAuth2AccessTokenException extends SaOAuth2Exception implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

accessToken

String accessToken

具体引起异常的 Access-Token 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2AccessTokenScopeException

class SaOAuth2AccessTokenScopeException extends SaOAuth2AccessTokenException implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

accessToken

String accessToken

具体引起异常的 Access-Token 值

scope

String scope

具体引起异常的 scope 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2AuthorizationCodeException

class SaOAuth2AuthorizationCodeException extends SaOAuth2Exception implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

authorizationCode

String authorizationCode

具体引起异常的 code 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2ClientModelException

class SaOAuth2ClientModelException extends SaOAuth2Exception implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

clientId

String clientId

具体引起异常的 ClientId 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2ClientModelScopeException

class SaOAuth2ClientModelScopeException extends SaOAuth2ClientModelException implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

clientId

String clientId

具体引起异常的 ClientId 值

scope

String scope

具体引起异常的 scope 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2ClientTokenException

class SaOAuth2ClientTokenException extends SaOAuth2Exception implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

clientToken

String clientToken

具体引起异常的 Client-Token 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2ClientTokenScopeException

class SaOAuth2ClientTokenScopeException extends SaOAuth2ClientTokenException implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

clientToken

String clientToken

具体引起异常的 Client-Token 值

scope

String scope

具体引起异常的 scope 值

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2Exception

class SaOAuth2Exception extends cn.dev33.satoken.exception.SaTokenException implements Serializable

serialVersionUID:

6806129545290130114L

异常错误 cn.dev33.satoken.oauth2.exception.SaOAuth2RefreshTokenException

class SaOAuth2RefreshTokenException extends SaOAuth2Exception implements Serializable

serialVersionUID:

6806129545290130114L

序列化字段

refreshToken

String refreshToken

具体引起异常的 Refresh-Token 值