Serialized Form

Package me.zhyd.oauth.exception

Exception me.zhyd.oauth.exception.AuthException

class AuthException extends RuntimeException implements Serializable

Serialized Fields

errorCode

int errorCode

errorMsg

String errorMsg

Package me.zhyd.oauth.model

Class me.zhyd.oauth.model.AuthCallback

class AuthCallback extends Object implements Serializable

Serialized Fields

auth_code

String auth_code

访问AuthorizeUrl后回调时带的参数auth_code，该参数目前只使用于支付宝登录

authorization_code

String authorization_code

华为授权登录接受code的参数名

Since:

1.10.0

code

String code

访问AuthorizeUrl后回调时带的参数code

error

String error

苹果错误信息，仅在用户取消授权时返回此值

See Also:

• error response

oauth_token

String oauth_token

Twitter回调后返回的oauth_token

Since:

1.13.0

oauth_verifier

String oauth_verifier

Twitter回调后返回的oauth_verifier

Since:

1.13.0

state

String state

访问AuthorizeUrl后回调时带的参数state，用于和请求AuthorizeUrl前的state比较，防止CSRF攻击

user

String user

苹果仅在用户首次授权应用程序时返回此值。如果您的应用程序已经获得了用户的授权，那么苹果将不会再次返回此值

See Also:

• user info

Class me.zhyd.oauth.model.AuthResponse

class AuthResponse extends Object implements Serializable

Serialized Fields

code

int code

授权响应状态码

data

T data

授权响应数据，当且仅当 code = 2000 时返回

msg

String msg

授权响应信息

Class me.zhyd.oauth.model.AuthToken

class AuthToken extends Object implements Serializable

Serialized Fields

accessCode

String accessCode

accessToken

String accessToken

code

String code

企业微信附带属性

Since:

1.10.0

corpId

String corpId

新版钉钉附带属性

Since:

1.16.7

expireIn

int expireIn

idToken

String idToken

macAlgorithm

String macAlgorithm

小米附带属性

macKey

String macKey

oauthCallbackConfirmed

Boolean oauthCallbackConfirmed

oauthToken

String oauthToken

Twitter附带属性

Since:

1.13.0

oauthTokenSecret

String oauthTokenSecret

openId

String openId

refreshToken

String refreshToken

refreshTokenExpireIn

int refreshTokenExpireIn

scope

String scope

Google附带属性

screenName

String screenName

snapshotUser

boolean snapshotUser

微信公众号 - 网页授权的登录时可用

微信针对网页授权登录，增加了一个快照页的逻辑，快照页获取到的微信用户的 uid oid 和头像昵称都是虚拟的信息

tokenType

String tokenType

uid

String uid

unionId

String unionId

userId

String userId

username

String username

Apple附带属性

Class me.zhyd.oauth.model.AuthUser

class AuthUser extends Object implements Serializable

Serialized Fields

avatar

String avatar

用户头像

blog

String blog

用户网址

company

String company

所在公司

email

String email

用户邮箱

gender

AuthUserGender gender

性别

location

String location

位置

nickname

String nickname

用户昵称

rawUserInfo

com.alibaba.fastjson2.JSONObject rawUserInfo

第三方平台返回的原始用户信息

remark

String remark

用户备注（各平台中的用户个人介绍）

snapshotUser

boolean snapshotUser

微信公众号 - 网页授权的登录时可用

微信针对网页授权登录，增加了一个快照页的逻辑，快照页获取到的微信用户的 uid oid 和头像昵称都是虚拟的信息

source

String source

用户来源

token

AuthToken token

用户授权的token信息

username

String username

用户名

uuid

String uuid

用户第三方系统的唯一id。在调用方集成该组件时，可以用uuid + source唯一确定一个用户

Since:

1.3.3