me.zhyd.oauth.request

类 AuthOktaRequest

java.lang.Object

me.zhyd.oauth.request.AuthDefaultRequest

me.zhyd.oauth.request.AuthOktaRequest

所有已实现的接口:

AuthRequest

public class AuthOktaRequest
extends AuthDefaultRequest

Okta 登录

https://{domainPrefix}.okta.com/oauth2/default/.well-known/oauth-authorization-server

从以下版本开始:

1.16.0

作者:

yadong.zhang (yadong.zhang0415(a)gmail.com)

字段概要

从类继承的字段 me.zhyd.oauth.request.AuthDefaultRequest

authStateCache, config, source

构造器概要

构造器

构造器和说明
AuthOktaRequest(AuthConfig config)
AuthOktaRequest(AuthConfig config, AuthStateCache authStateCache)

方法概要

限定符和类型	方法和说明
String	accessTokenUrl(String code) 返回获取accessToken的url
String	authorize(String state) 返回带state参数的授权url，授权回调时会带上这个state
protected AuthToken	getAccessToken(AuthCallback authCallback) 获取access token
protected AuthUser	getUserInfo(AuthToken authToken) 使用token换取用户信息
AuthResponse	refresh(AuthToken authToken) 刷新access token （续期）
protected String	refreshTokenUrl(String refreshToken) 返回获取accessToken的url
AuthResponse	revoke(AuthToken authToken) 撤销授权
protected String	revokeUrl(AuthToken authToken) 返回获取revoke authorization的url
String	userInfoUrl(AuthToken authToken) 返回获取userInfo的url

从类继承的方法 me.zhyd.oauth.request.AuthDefaultRequest

authorize, checkCode, doGetAuthorizationCode, doGetRevoke, doGetUserInfo, doPostAuthorizationCode, doPostRevoke, doPostUserInfo, getRealState, getScopes, login

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AuthOktaRequest

public AuthOktaRequest(AuthConfig config)

AuthOktaRequest

public AuthOktaRequest(AuthConfig config,
                       AuthStateCache authStateCache)

方法详细资料

getAccessToken

protected AuthToken getAccessToken(AuthCallback authCallback)

从类复制的说明: AuthDefaultRequest

获取access token

指定者:

getAccessToken 在类中 AuthDefaultRequest

参数:

authCallback - 授权成功后的回调参数

返回:

token

另请参阅:

AuthDefaultRequest.authorize(), AuthDefaultRequest.authorize(String)

refresh

public AuthResponse refresh(AuthToken authToken)

从接口复制的说明: AuthRequest

刷新access token （续期）

参数:

authToken - 登录成功后返回的Token信息

返回:

AuthResponse

getUserInfo

protected AuthUser getUserInfo(AuthToken authToken)

从类复制的说明: AuthDefaultRequest

使用token换取用户信息

指定者:

getUserInfo 在类中 AuthDefaultRequest

参数:

authToken - token信息

返回:

用户信息

另请参阅:

AuthDefaultRequest.getAccessToken(AuthCallback)

revoke

public AuthResponse revoke(AuthToken authToken)

从接口复制的说明: AuthRequest

撤销授权

参数:

authToken - 登录成功后返回的Token信息

返回:

AuthResponse

authorize

public String authorize(String state)

从类复制的说明: AuthDefaultRequest

返回带state参数的授权url，授权回调时会带上这个state

指定者:

authorize 在接口中 AuthRequest

覆盖:

authorize 在类中 AuthDefaultRequest

参数:

state - state 验证授权流程的参数，可以防止csrf

返回:

返回授权地址

accessTokenUrl

public String accessTokenUrl(String code)

从类复制的说明: AuthDefaultRequest

返回获取accessToken的url

覆盖:

accessTokenUrl 在类中 AuthDefaultRequest

参数:

code - 授权码

返回:

返回获取accessToken的url

refreshTokenUrl

protected String refreshTokenUrl(String refreshToken)

从类复制的说明: AuthDefaultRequest

返回获取accessToken的url

覆盖:

refreshTokenUrl 在类中 AuthDefaultRequest

参数:

refreshToken - refreshToken

返回:

返回获取accessToken的url

revokeUrl

protected String revokeUrl(AuthToken authToken)

从类复制的说明: AuthDefaultRequest

返回获取revoke authorization的url

覆盖:

revokeUrl 在类中 AuthDefaultRequest

参数:

authToken - token

返回:

返回获取revoke authorization的url

userInfoUrl

public String userInfoUrl(AuthToken authToken)

从类复制的说明: AuthDefaultRequest

返回获取userInfo的url

覆盖:

userInfoUrl 在类中 AuthDefaultRequest

参数:

authToken - token

返回:

返回获取userInfo的url