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 |
列挙値 |
CHALLENGE |
|
FAILURE |
|
IGNORE |
|
SUCCESS |
|
◆ challenge()
void org.keycloak.authentication.RequiredActionContext.challenge |
( |
Response |
response | ) |
|
Send a challenge Response back to user
- 引数
-
◆ failure()
void org.keycloak.authentication.RequiredActionContext.failure |
( |
| ) |
|
Abort the authentication with an error
◆ form()
Create a Freemarker form builder that presets the user, action URI, and a generated access code
- 戻り値
◆ 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.
- 戻り値
◆ getActionUrl() [1/3]
URI org.keycloak.authentication.RequiredActionContext.getActionUrl |
( |
String |
code | ) |
|
Get the action URL for the required action.
- 引数
-
code | client sessino access code |
- 戻り値
◆ getActionUrl() [2/3]
URI org.keycloak.authentication.RequiredActionContext.getActionUrl |
( |
| ) |
|
Get the action URL for the required action. This auto-generates the access code.
- 戻り値
◆ 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) |
- 戻り値
◆ getAuthenticationSession()
AuthenticationSessionModel org.keycloak.authentication.RequiredActionContext.getAuthenticationSession |
( |
| ) |
|
◆ getChallenge()
Response org.keycloak.authentication.RequiredActionContext.getChallenge |
( |
| ) |
|
If challenge has been sent this returns the JAX-RS Response
- 戻り値
◆ getConnection()
ClientConnection org.keycloak.authentication.RequiredActionContext.getConnection |
( |
| ) |
|
◆ getEvent()
EventBuilder org.keycloak.authentication.RequiredActionContext.getEvent |
( |
| ) |
|
Current event builder being used
- 戻り値
◆ getHttpRequest()
HttpRequest org.keycloak.authentication.RequiredActionContext.getHttpRequest |
( |
| ) |
|
◆ getRealm()
RealmModel org.keycloak.authentication.RequiredActionContext.getRealm |
( |
| ) |
|
◆ getSession()
KeycloakSession org.keycloak.authentication.RequiredActionContext.getSession |
( |
| ) |
|
◆ getStatus()
Status org.keycloak.authentication.RequiredActionContext.getStatus |
( |
| ) |
|
◆ getUriInfo()
UriInfo org.keycloak.authentication.RequiredActionContext.getUriInfo |
( |
| ) |
|
◆ getUser()
UserModel org.keycloak.authentication.RequiredActionContext.getUser |
( |
| ) |
|
◆ ignore()
void org.keycloak.authentication.RequiredActionContext.ignore |
( |
| ) |
|
Ignore this required action and go onto the next, or complete the flow.
◆ success()
void org.keycloak.authentication.RequiredActionContext.success |
( |
| ) |
|
Mark this required action as successful. The required action will be removed from the UserModel
このインタフェース詳解は次のファイルから抽出されました:
- D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/authentication/RequiredActionContext.java