Package org.keycloak.services.resources

Class LoginActionsService

java.lang.Object

org.keycloak.services.resources.LoginActionsService

public class LoginActionsService
extends Object

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_SESSION_ID
static final String	AUTHENTICATE_PATH
static final String	CANCEL_AIA
static final String	DETACHED_INFO_PATH
static final String	FIRST_BROKER_LOGIN_PATH
static final String	FORWARDED_ERROR_MESSAGE_NOTE
protected final jakarta.ws.rs.core.HttpHeaders	headers
static final String	POST_BROKER_LOGIN_PATH
static final String	REGISTRATION_PATH
static final String	REQUIRED_ACTION
static final String	RESET_CREDENTIALS_PATH
static final String	RESTART_PATH
protected final KeycloakSession	session
static final String	SESSION_CODE

Constructor Summary

Constructors

Constructor	Description
LoginActionsService(KeycloakSession session, EventBuilder event)

Method Summary

Modifier and Type	Method	Description
static jakarta.ws.rs.core.UriBuilder	actionTokenProcessor(jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	authenticate(String authSessionId, String code, String execution, String clientId, String tabId)	protocol independent login page entry point
jakarta.ws.rs.core.Response	authenticateForm(String authSessionId, String code, String execution, String clientId, String tabId)	URL called after login page.
static jakarta.ws.rs.core.UriBuilder	authenticationFormProcessor(jakarta.ws.rs.core.UriInfo uriInfo)
protected jakarta.ws.rs.core.Response	brokerLoginFlow(String authSessionId, String code, String execution, String clientId, String tabId, String flowPath)
jakarta.ws.rs.core.Response	detachedInfo(String stateCheckerParam)	protocol independent "detached info" page.
jakarta.ws.rs.core.Response	executeActionToken(String authSessionId, String key, String execution, String clientId, String tabId)	Handles a given token using the given token handler.
jakarta.ws.rs.core.Response	firstBrokerLoginGet(String authSessionId, String code, String execution, String clientId, String tabId)
jakarta.ws.rs.core.Response	firstBrokerLoginPost(String authSessionId, String code, String execution, String clientId, String tabId)
static jakarta.ws.rs.core.UriBuilder	firstBrokerLoginProcessor(jakarta.ws.rs.core.UriInfo uriInfo)
protected URI	getLastExecutionUrl(String flowPath, String executionId, String clientId, String tabId)
protected <T extends JsonWebToken & SingleUseObjectKeyModel> jakarta.ws.rs.core.Response	handleActionToken(String tokenString, String execution, String clientId, String tabId)
static jakarta.ws.rs.core.UriBuilder	loginActionsBaseUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)
static jakarta.ws.rs.core.UriBuilder	loginActionsBaseUrl(jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	postBrokerLoginGet(String authSessionId, String code, String execution, String clientId, String tabId)
jakarta.ws.rs.core.Response	postBrokerLoginPost(String authSessionId, String code, String execution, String clientId, String tabId)
static jakarta.ws.rs.core.UriBuilder	postBrokerLoginProcessor(jakarta.ws.rs.core.UriInfo uriInfo)
protected jakarta.ws.rs.core.Response	processAuthentication(boolean action, String execution, AuthenticationSessionModel authSession, String errorMessage)
jakarta.ws.rs.core.Response	processConsent()	OAuth grant page.
protected jakarta.ws.rs.core.Response	processFlow(boolean action, String execution, AuthenticationSessionModel authSession, String flowPath, AuthenticationFlowModel flow, String errorMessage, AuthenticationProcessor processor)
protected void	processLocaleParam(AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	processRegister(String authSessionId, String code, String execution, String clientId, String tabId)	Registration
protected jakarta.ws.rs.core.Response	processRegistration(boolean action, String execution, AuthenticationSessionModel authSession, String errorMessage)
protected jakarta.ws.rs.core.Response	processResetCredentials(boolean actionRequest, String execution, AuthenticationSessionModel authSession, String errorMessage)
static jakarta.ws.rs.core.Response	redirectToAfterBrokerLoginEndpoint(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, AuthenticationSessionModel authSession, boolean firstBrokerLogin)
jakarta.ws.rs.core.Response	registerPage(String authSessionId, String code, String execution, String clientId, String tabId)	protocol independent registration page entry point
static jakarta.ws.rs.core.UriBuilder	registrationFormProcessor(jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	requiredActionGET(String authSessionId, String code, String action, String clientId, String tabId)
jakarta.ws.rs.core.Response	requiredActionPOST(String authSessionId, String code, String action, String clientId, String tabId)
static jakarta.ws.rs.core.UriBuilder	requiredActionProcessor(jakarta.ws.rs.core.UriInfo uriInfo)
protected jakarta.ws.rs.core.Response	resetCredentials(String authSessionId, String code, String execution, String clientId, String tabId)
jakarta.ws.rs.core.Response	resetCredentialsGET(String authSessionId, String code, String execution, String clientId, String tabId)	Endpoint for executing reset credentials flow.
jakarta.ws.rs.core.Response	resetCredentialsPOST(String authSessionId, String code, String execution, String clientId, String tabId, String key)
jakarta.ws.rs.core.Response	restartSession(String authSessionId, String clientId, String tabId, String skipLogout)	protocol independent page for restart of the flow

Methods inherited from class java.lang.Object

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

Field Details

AUTHENTICATE_PATH

public static final String AUTHENTICATE_PATH

See Also:

• Constant Field Values

REGISTRATION_PATH

public static final String REGISTRATION_PATH

See Also:

• Constant Field Values

RESET_CREDENTIALS_PATH

public static final String RESET_CREDENTIALS_PATH

See Also:

• Constant Field Values

REQUIRED_ACTION

public static final String REQUIRED_ACTION

See Also:

• Constant Field Values

FIRST_BROKER_LOGIN_PATH

public static final String FIRST_BROKER_LOGIN_PATH

See Also:

• Constant Field Values

POST_BROKER_LOGIN_PATH

public static final String POST_BROKER_LOGIN_PATH

See Also:

• Constant Field Values

RESTART_PATH

public static final String RESTART_PATH

See Also:

• Constant Field Values

DETACHED_INFO_PATH

public static final String DETACHED_INFO_PATH

See Also:

• Constant Field Values

FORWARDED_ERROR_MESSAGE_NOTE

public static final String FORWARDED_ERROR_MESSAGE_NOTE

See Also:

• Constant Field Values

SESSION_CODE

public static final String SESSION_CODE

See Also:

• Constant Field Values

AUTH_SESSION_ID

public static final String AUTH_SESSION_ID

See Also:

• Constant Field Values

CANCEL_AIA

public static final String CANCEL_AIA

See Also:

• Constant Field Values

headers

protected final jakarta.ws.rs.core.HttpHeaders headers

session

protected final KeycloakSession session

Constructor Details

LoginActionsService

public LoginActionsService(KeycloakSession session,
 EventBuilder event)

Method Details

loginActionsBaseUrl

public static jakarta.ws.rs.core.UriBuilder loginActionsBaseUrl(jakarta.ws.rs.core.UriInfo uriInfo)

authenticationFormProcessor

public static jakarta.ws.rs.core.UriBuilder authenticationFormProcessor(jakarta.ws.rs.core.UriInfo uriInfo)

requiredActionProcessor

public static jakarta.ws.rs.core.UriBuilder requiredActionProcessor(jakarta.ws.rs.core.UriInfo uriInfo)

actionTokenProcessor

public static jakarta.ws.rs.core.UriBuilder actionTokenProcessor(jakarta.ws.rs.core.UriInfo uriInfo)

registrationFormProcessor

public static jakarta.ws.rs.core.UriBuilder registrationFormProcessor(jakarta.ws.rs.core.UriInfo uriInfo)

firstBrokerLoginProcessor

public static jakarta.ws.rs.core.UriBuilder firstBrokerLoginProcessor(jakarta.ws.rs.core.UriInfo uriInfo)

postBrokerLoginProcessor

public static jakarta.ws.rs.core.UriBuilder postBrokerLoginProcessor(jakarta.ws.rs.core.UriInfo uriInfo)

loginActionsBaseUrl

public static jakarta.ws.rs.core.UriBuilder loginActionsBaseUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)

getLastExecutionUrl

protected URI getLastExecutionUrl(String flowPath,
 String executionId,
 String clientId,
 String tabId)

restartSession

@Path("restart")
@GET
public jakarta.ws.rs.core.Response restartSession(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId,
 @QueryParam("skip_logout")
 String skipLogout)

protocol independent page for restart of the flow

Returns:

detachedInfo

@Path("detached-info")
@GET
public jakarta.ws.rs.core.Response detachedInfo(@QueryParam("kc_state_checker")
 String stateCheckerParam)

protocol independent "detached info" page. Shown when locale is changed by user on info/error page after authenticationSession was already removed.

Returns:

authenticate

@Path("authenticate")
@GET
public jakarta.ws.rs.core.Response authenticate(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

protocol independent login page entry point

Parameters:

code -

Returns:

processLocaleParam

protected void processLocaleParam(AuthenticationSessionModel authSession)

processAuthentication

protected jakarta.ws.rs.core.Response processAuthentication(boolean action,
 String execution,
 AuthenticationSessionModel authSession,
 String errorMessage)

processFlow

protected jakarta.ws.rs.core.Response processFlow(boolean action,
 String execution,
 AuthenticationSessionModel authSession,
 String flowPath,
 AuthenticationFlowModel flow,
 String errorMessage,
 AuthenticationProcessor processor)

authenticateForm

@Path("authenticate")
@POST
public jakarta.ws.rs.core.Response authenticateForm(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

URL called after login page. YOU SHOULD NEVER INVOKE THIS DIRECTLY!

Parameters:

code -

Returns:

resetCredentialsPOST

@Path("reset-credentials")
@POST
public jakarta.ws.rs.core.Response resetCredentialsPOST(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId,
 @QueryParam("key")
 String key)

resetCredentialsGET

@Path("reset-credentials")
@GET
public jakarta.ws.rs.core.Response resetCredentialsGET(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

Endpoint for executing reset credentials flow. If token is null, a authentication session is created with the account service as the client. Successful reset sends you to the account page. Note, account service must be enabled.

Parameters:

code -

execution -

Returns:

resetCredentials

protected jakarta.ws.rs.core.Response resetCredentials(String authSessionId,
 String code,
 String execution,
 String clientId,
 String tabId)

Parameters:

code -

execution -

Returns:

executeActionToken

@Path("action-token")
@GET
public jakarta.ws.rs.core.Response executeActionToken(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("key")
 String key,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

Handles a given token using the given token handler. If there is any VerificationException thrown in the handler, it is handled automatically here to reduce boilerplate code.

Parameters:

key -

execution -

Returns:

handleActionToken

protected <T extends JsonWebToken & SingleUseObjectKeyModel>
jakarta.ws.rs.core.Response handleActionToken(String tokenString,
 String execution,
 String clientId,
 String tabId)

processResetCredentials

protected jakarta.ws.rs.core.Response processResetCredentials(boolean actionRequest,
 String execution,
 AuthenticationSessionModel authSession,
 String errorMessage)

processRegistration

protected jakarta.ws.rs.core.Response processRegistration(boolean action,
 String execution,
 AuthenticationSessionModel authSession,
 String errorMessage)

registerPage

@Path("registration")
@GET
public jakarta.ws.rs.core.Response registerPage(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

protocol independent registration page entry point

Parameters:

code -

Returns:

processRegister

@Path("registration")
@POST
public jakarta.ws.rs.core.Response processRegister(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

Registration

Parameters:

code -

Returns:

firstBrokerLoginGet

@Path("first-broker-login")
@GET
public jakarta.ws.rs.core.Response firstBrokerLoginGet(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

firstBrokerLoginPost

@Path("first-broker-login")
@POST
public jakarta.ws.rs.core.Response firstBrokerLoginPost(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

postBrokerLoginGet

@Path("post-broker-login")
@GET
public jakarta.ws.rs.core.Response postBrokerLoginGet(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

postBrokerLoginPost

@Path("post-broker-login")
@POST
public jakarta.ws.rs.core.Response postBrokerLoginPost(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String execution,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

brokerLoginFlow

protected jakarta.ws.rs.core.Response brokerLoginFlow(String authSessionId,
 String code,
 String execution,
 String clientId,
 String tabId,
 String flowPath)

redirectToAfterBrokerLoginEndpoint

public static jakarta.ws.rs.core.Response redirectToAfterBrokerLoginEndpoint(KeycloakSession session,
 RealmModel realm,
 jakarta.ws.rs.core.UriInfo uriInfo,
 AuthenticationSessionModel authSession,
 boolean firstBrokerLogin)

processConsent

@Path("consent")
@POST
@Consumes("application/x-www-form-urlencoded")
public jakarta.ws.rs.core.Response processConsent()

OAuth grant page. You should not invoked this directly!

Returns:

requiredActionPOST

@Path("required-action")
@POST
public jakarta.ws.rs.core.Response requiredActionPOST(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String action,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

requiredActionGET

@Path("required-action")
@GET
public jakarta.ws.rs.core.Response requiredActionGET(@QueryParam("auth_session_id")
 String authSessionId,
 @QueryParam("session_code")
 String code,
 @QueryParam("execution")
 String action,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)