public interface RequiredActionContext
Modifier and Type | Interface and Description |
---|---|
static class |
RequiredActionContext.KcActionStatus |
static class |
RequiredActionContext.Status |
Modifier and Type | Method and Description |
---|---|
void |
challenge(javax.ws.rs.core.Response response)
Send a challenge Response back to user
|
void |
failure()
Abort the authentication with an error
|
LoginFormsProvider |
form()
Create a Freemarker form builder that presets the user, action URI, and a generated access code
|
String |
generateCode()
Generates access code and updates clientsession timestamp
Access codes must be included in form action callbacks as a query parameter.
|
URI |
getActionUrl()
Get the action URL for the required action.
|
URI |
getActionUrl(boolean authSessionIdParam)
Get the action URL for the required action.
|
URI |
getActionUrl(String code)
Get the action URL for the required action.
|
AuthenticationSessionModel |
getAuthenticationSession() |
javax.ws.rs.core.Response |
getChallenge()
If challenge has been sent this returns the JAX-RS Response
|
ClientConnection |
getConnection() |
EventBuilder |
getEvent()
Current event builder being used
|
org.jboss.resteasy.spi.HttpRequest |
getHttpRequest() |
RealmModel |
getRealm() |
KeycloakSession |
getSession() |
RequiredActionContext.Status |
getStatus() |
javax.ws.rs.core.UriInfo |
getUriInfo() |
UserModel |
getUser()
Current user
|
void |
ignore()
Ignore this required action and go onto the next, or complete the flow.
|
void |
success()
Mark this required action as successful.
|
URI getActionUrl(String code)
code
- client sessino access codeURI getActionUrl()
URI getActionUrl(boolean authSessionIdParam)
authSessionIdParam
- if true, will embed session id as query param. Useful for clients that don't support cookies (i.e. console)LoginFormsProvider form()
javax.ws.rs.core.Response getChallenge()
EventBuilder getEvent()
UserModel getUser()
RealmModel getRealm()
AuthenticationSessionModel getAuthenticationSession()
ClientConnection getConnection()
javax.ws.rs.core.UriInfo getUriInfo()
KeycloakSession getSession()
org.jboss.resteasy.spi.HttpRequest getHttpRequest()
String generateCode()
RequiredActionContext.Status getStatus()
void challenge(javax.ws.rs.core.Response response)
response
- void failure()
void success()
void ignore()
Copyright © 2021 JBoss by Red Hat. All rights reserved.