org.keycloak.authentication.RequiredActionContext インタフェース

org.keycloak.authentication.RequiredActionContext の継承関係図

org.keycloak.authentication.RequiredActionContext 連携図

クラス
enum	Status

公開メンバ関数
URI	getActionUrl (String code)
URI	getActionUrl ()
URI	getActionUrl (boolean authSessionIdParam)
LoginFormsProvider	form ()
Response	getChallenge ()
EventBuilder	getEvent ()
UserModel	getUser ()
RealmModel	getRealm ()
AuthenticationSessionModel	getAuthenticationSession ()
ClientConnection	getConnection ()
UriInfo	getUriInfo ()
KeycloakSession	getSession ()
HttpRequest	getHttpRequest ()
String	generateCode ()
Status	getStatus ()
void	challenge (Response response)
void	failure ()
void	success ()
void	ignore ()

詳解

Interface that encapsulates current information about the current requred action

著者

Bill Burke

バージョン

Revision

1

---

クラス詳解

org::keycloak::authentication::RequiredActionContext::Status

enum org::keycloak::authentication::RequiredActionContext::Status

org.keycloak.authentication.RequiredActionContext.Status 連携図

列挙値
CHALLENGE
FAILURE
IGNORE
SUCCESS

関数詳解

challenge()

void org.keycloak.authentication.RequiredActionContext.challenge

(

Response

response

)

Send a challenge Response back to user

引数

response

org.keycloak.authentication.RequiredActionContextResultで実装されています。

failure()

void org.keycloak.authentication.RequiredActionContext.failure

(

)

Abort the authentication with an error

org.keycloak.authentication.RequiredActionContextResultで実装されています。

form()

LoginFormsProvider org.keycloak.authentication.RequiredActionContext.form

(

)

Create a Freemarker form builder that presets the user, action URI, and a generated access code

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

generateCode()

String org.keycloak.authentication.RequiredActionContext.generateCode

(

)

Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getActionUrl() [1/3]

URI org.keycloak.authentication.RequiredActionContext.getActionUrl

(

String

code

)

Get the action URL for the required action.

引数

code	client sessino access code

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getActionUrl() [2/3]

URI org.keycloak.authentication.RequiredActionContext.getActionUrl

(

)

Get the action URL for the required action. This auto-generates the access code.

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getActionUrl() [3/3]

URI org.keycloak.authentication.RequiredActionContext.getActionUrl

(

boolean

authSessionIdParam

)

Get the action URL for the required action. This auto-generates the access code.

引数

authSessionIdParam

if true, will embed session id as query param. Useful for clients that don't support cookies (i.e. console)

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getAuthenticationSession()

AuthenticationSessionModel org.keycloak.authentication.RequiredActionContext.getAuthenticationSession

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getChallenge()

Response org.keycloak.authentication.RequiredActionContext.getChallenge

(

)

If challenge has been sent this returns the JAX-RS Response

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getConnection()

ClientConnection org.keycloak.authentication.RequiredActionContext.getConnection

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getEvent()

EventBuilder org.keycloak.authentication.RequiredActionContext.getEvent

(

)

Current event builder being used

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getHttpRequest()

HttpRequest org.keycloak.authentication.RequiredActionContext.getHttpRequest

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getRealm()

RealmModel org.keycloak.authentication.RequiredActionContext.getRealm

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getSession()

KeycloakSession org.keycloak.authentication.RequiredActionContext.getSession

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getStatus()

Status org.keycloak.authentication.RequiredActionContext.getStatus

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getUriInfo()

UriInfo org.keycloak.authentication.RequiredActionContext.getUriInfo

(

)

org.keycloak.authentication.RequiredActionContextResultで実装されています。

getUser()

UserModel org.keycloak.authentication.RequiredActionContext.getUser

(

)

Current user

戻り値

org.keycloak.authentication.RequiredActionContextResultで実装されています。

ignore()

void org.keycloak.authentication.RequiredActionContext.ignore

(

)

Ignore this required action and go onto the next, or complete the flow.

org.keycloak.authentication.RequiredActionContextResultで実装されています。

success()

void org.keycloak.authentication.RequiredActionContext.success

(

)

Mark this required action as successful. The required action will be removed from the UserModel

org.keycloak.authentication.RequiredActionContextResultで実装されています。

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/RequiredActionContext.java