Package org.keycloak.forms.login

Interface LoginFormsProvider

All Superinterfaces:
Provider
All Known Implementing Classes:
FreeMarkerLoginFormsProvider
public interface LoginFormsProvider extends Provider
Author:
Stian Thorgersen

  • Field Details

  • Method Details

    • addScript

      void addScript(String scriptUrl)
      Adds a script to the html header
      Parameters:
      scriptUrl -

    • createResponse

      jakarta.ws.rs.core.Response createResponse(UserModel.RequiredAction action)

    • createForm

      jakarta.ws.rs.core.Response createForm(String form)

    • getMessage

      String getMessage(String message)

    • createLoginUsernamePassword

      jakarta.ws.rs.core.Response createLoginUsernamePassword()

    • createLoginUsername

      jakarta.ws.rs.core.Response createLoginUsername()

    • createLoginPassword

      jakarta.ws.rs.core.Response createLoginPassword()

    • createOtpReset

      jakarta.ws.rs.core.Response createOtpReset()

    • createPasswordReset

      jakarta.ws.rs.core.Response createPasswordReset()

    • createLoginTotp

      jakarta.ws.rs.core.Response createLoginTotp()

    • createLoginRecoveryAuthnCode

      jakarta.ws.rs.core.Response createLoginRecoveryAuthnCode()

    • createLoginWebAuthn

      jakarta.ws.rs.core.Response createLoginWebAuthn()

    • createRegistration

      jakarta.ws.rs.core.Response createRegistration()

    • createInfoPage

      jakarta.ws.rs.core.Response createInfoPage()

    • createUpdateProfilePage

      jakarta.ws.rs.core.Response createUpdateProfilePage()

    • createIdpLinkConfirmLinkPage

      jakarta.ws.rs.core.Response createIdpLinkConfirmLinkPage()

    • createIdpLinkConfirmOverrideLinkPage

      jakarta.ws.rs.core.Response createIdpLinkConfirmOverrideLinkPage()

    • createIdpLinkEmailPage

      jakarta.ws.rs.core.Response createIdpLinkEmailPage()

    • createLoginExpiredPage

      jakarta.ws.rs.core.Response createLoginExpiredPage()

    • createErrorPage

      jakarta.ws.rs.core.Response createErrorPage(jakarta.ws.rs.core.Response.Status status)

    • createWebAuthnErrorPage

      jakarta.ws.rs.core.Response createWebAuthnErrorPage()

    • createOAuthGrant

      jakarta.ws.rs.core.Response createOAuthGrant()

    • createSelectAuthenticator

      jakarta.ws.rs.core.Response createSelectAuthenticator()

    • createOAuth2DeviceVerifyUserCodePage

      jakarta.ws.rs.core.Response createOAuth2DeviceVerifyUserCodePage()

    • createCode

      jakarta.ws.rs.core.Response createCode()

    • createX509ConfirmPage

      jakarta.ws.rs.core.Response createX509ConfirmPage()

    • createSamlPostForm

      jakarta.ws.rs.core.Response createSamlPostForm()

    • createFrontChannelLogoutPage

      jakarta.ws.rs.core.Response createFrontChannelLogoutPage()

    • createLogoutConfirmPage

      jakarta.ws.rs.core.Response createLogoutConfirmPage()

    • setAuthenticationSession

      LoginFormsProvider setAuthenticationSession(AuthenticationSessionModel authenticationSession)

    • setClientSessionCode

      LoginFormsProvider setClientSessionCode(String accessCode)

    • setAccessRequest

      LoginFormsProvider setAccessRequest(List<AuthorizationDetails> clientScopesRequested)

    • setError

      LoginFormsProvider setError(String message, Object... parameters)
      Set one global error message.
      Parameters:
      message - key of message
      parameters - to be formatted into message

    • setErrors

      LoginFormsProvider setErrors(List<FormMessage> messages)
      Set multiple error messages.
      Parameters:
      messages - to be set

    • addError

      LoginFormsProvider addError(FormMessage errorMessage)

    • addSuccess

      LoginFormsProvider addSuccess(FormMessage errorMessage)
      Add a success message to the form
      Parameters:
      errorMessage -
      Returns:

    • setSuccess

      LoginFormsProvider setSuccess(String message, Object... parameters)

    • setInfo

      LoginFormsProvider setInfo(String message, Object... parameters)

    • setMessage

      LoginFormsProvider setMessage(MessageType type, String message, Object... parameters)

    • setDetachedAuthSession

      LoginFormsProvider setDetachedAuthSession()
      Used when authenticationSession was already removed for this browser session and hence we don't have any authenticationSession or user data. Would just repeat previous info/error page after language is changed

    • setUser

      LoginFormsProvider setUser(UserModel user)

    • setResponseHeader

      LoginFormsProvider setResponseHeader(String headerName, String headerValue)

    • setFormData

      LoginFormsProvider setFormData(jakarta.ws.rs.core.MultivaluedMap<String,String> formData)

    • setAttribute

      LoginFormsProvider setAttribute(String name, Object value)

    • setStatus

      LoginFormsProvider setStatus(jakarta.ws.rs.core.Response.Status status)

    • setActionUri

      LoginFormsProvider setActionUri(URI requestUri)

    • setExecution

      LoginFormsProvider setExecution(String execution)

    • setAuthContext

      LoginFormsProvider setAuthContext(AuthenticationFlowContext context)

    • setAttributeMapper

      LoginFormsProvider setAttributeMapper(Function<Map<String,Object>,Map<String,Object>> configurer)