Package me.zhyd.oauth.request

Class AuthOktaRequest

java.lang.Object

me.zhyd.oauth.request.AuthDefaultRequest

me.zhyd.oauth.request.AuthOktaRequest

All Implemented Interfaces:

AuthRequest

public class AuthOktaRequest
extends AuthDefaultRequest

Okta 登录

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

Since:

1.16.0

Author:

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

Field Summary

Fields inherited from class me.zhyd.oauth.request.AuthDefaultRequest

authStateCache, config, source

Constructor Summary

Constructors

Constructor	Description
AuthOktaRequest(AuthConfig config)
AuthOktaRequest(AuthConfig config, AuthStateCache authStateCache)

Method Summary

Modifier and Type	Method	Description
String	accessTokenUrl(String code)	返回获取accessToken的url
String	authorize(String state)	返回带state参数的授权url，授权回调时会带上这个state
AuthToken	getAccessToken(AuthCallback authCallback)	获取access token
AuthUser	getUserInfo(AuthToken authToken)	使用token换取用户信息
AuthResponse<AuthToken>	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

Methods inherited from class me.zhyd.oauth.request.AuthDefaultRequest

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

Methods inherited from class java.lang.Object

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

Constructor Details

AuthOktaRequest

public AuthOktaRequest(AuthConfig config)

AuthOktaRequest

public AuthOktaRequest(AuthConfig config,
 AuthStateCache authStateCache)

Method Details

getAccessToken

public AuthToken getAccessToken(AuthCallback authCallback)

Description copied from interface: AuthRequest

获取access token

Parameters:

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

Returns:

token

See Also:

• AuthDefaultRequest.authorize()
• AuthDefaultRequest.authorize(String)

refresh

public AuthResponse<AuthToken> refresh(AuthToken authToken)

Description copied from interface: AuthRequest

刷新access token （续期）

Parameters:

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

Returns:

AuthResponse

getUserInfo

public AuthUser getUserInfo(AuthToken authToken)

Description copied from interface: AuthRequest

使用token换取用户信息

Parameters:

authToken - token信息

Returns:

用户信息

See Also:

• AuthRequest.getAccessToken(AuthCallback)

revoke

public AuthResponse revoke(AuthToken authToken)

Description copied from interface: AuthRequest

撤销授权

Parameters:

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

Returns:

AuthResponse

authorize

public String authorize(String state)

Description copied from class: AuthDefaultRequest

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

Specified by:

authorize in interface AuthRequest

Overrides:

authorize in class AuthDefaultRequest

Parameters:

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

Returns:

返回授权地址

accessTokenUrl

public String accessTokenUrl(String code)

Description copied from class: AuthDefaultRequest

返回获取accessToken的url

Overrides:

accessTokenUrl in class AuthDefaultRequest

Parameters:

code - 授权码

Returns:

返回获取accessToken的url

refreshTokenUrl

protected String refreshTokenUrl(String refreshToken)

Description copied from class: AuthDefaultRequest

返回获取accessToken的url

Overrides:

refreshTokenUrl in class AuthDefaultRequest

Parameters:

refreshToken - refreshToken

Returns:

返回获取accessToken的url

revokeUrl

protected String revokeUrl(AuthToken authToken)

Description copied from class: AuthDefaultRequest

返回获取revoke authorization的url

Overrides:

revokeUrl in class AuthDefaultRequest

Parameters:

authToken - token

Returns:

返回获取revoke authorization的url

userInfoUrl

public String userInfoUrl(AuthToken authToken)

Description copied from class: AuthDefaultRequest

返回获取userInfo的url

Overrides:

userInfoUrl in class AuthDefaultRequest

Parameters:

authToken - token

Returns:

返回获取userInfo的url