Package org.keycloak.protocol

Enum Class LoginProtocol.Error

java.lang.Object

java.lang.Enum<LoginProtocol.Error>

org.keycloak.protocol.LoginProtocol.Error

All Implemented Interfaces:

Serializable, Comparable<LoginProtocol.Error>, Constable

Enclosing interface:

LoginProtocol

public static enum LoginProtocol.Error
extends Enum<LoginProtocol.Error>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALREADY_LOGGED_IN	User is already logged-in and he has userSession in this browser.
CANCELLED_AIA	Applications-initiated action was canceled by the user
CANCELLED_AIA_SILENT	Applications-initiated action was canceled by the user.
CANCELLED_BY_USER	Login cancelled by the user
CONSENT_DENIED	Consent denied by the user
PASSIVE_INTERACTION_REQUIRED	Passive authentication mode requested, user is logged in, but some other user interaction is necessary (eg.
PASSIVE_LOGIN_REQUIRED	Passive authentication mode requested but nobody is logged in

Method Summary

Modifier and Type	Method	Description
static LoginProtocol.Error	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LoginProtocol.Error[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CANCELLED_BY_USER

public static final LoginProtocol.Error CANCELLED_BY_USER

Login cancelled by the user

CANCELLED_AIA

public static final LoginProtocol.Error CANCELLED_AIA

Applications-initiated action was canceled by the user

CANCELLED_AIA_SILENT

public static final LoginProtocol.Error CANCELLED_AIA_SILENT

Applications-initiated action was canceled by the user. Do not send error.

ALREADY_LOGGED_IN

public static final LoginProtocol.Error ALREADY_LOGGED_IN

User is already logged-in and he has userSession in this browser. But authenticationSession is not valid anymore and hence could not continue authentication in proper way. Will need to redirect back to client, so client can retry authentication. Once client retries authentication, it will usually success automatically due SSO reauthentication.

CONSENT_DENIED

public static final LoginProtocol.Error CONSENT_DENIED

Consent denied by the user

PASSIVE_LOGIN_REQUIRED

public static final LoginProtocol.Error PASSIVE_LOGIN_REQUIRED

Passive authentication mode requested but nobody is logged in

PASSIVE_INTERACTION_REQUIRED

public static final LoginProtocol.Error PASSIVE_INTERACTION_REQUIRED

Passive authentication mode requested, user is logged in, but some other user interaction is necessary (eg. some required login actions exist or Consent approval is necessary for logged in user)

Method Details

values

public static LoginProtocol.Error[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LoginProtocol.Error valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null