Package org.keycloak.email

Enum Class ActionTokenEmail.Ineligibility

java.lang.Object

java.lang.Enum<ActionTokenEmail.Ineligibility>

org.keycloak.email.ActionTokenEmail.Ineligibility

All Implemented Interfaces:

Serializable, Comparable<ActionTokenEmail.Ineligibility>, Constable

Enclosing class:

ActionTokenEmail

public static enum ActionTokenEmail.Ineligibility
extends Enum<ActionTokenEmail.Ineligibility>

Outcomes of ActionTokenEmail.resolveParams(org.keycloak.models.KeycloakSession, org.keycloak.models.RealmModel, org.keycloak.models.UserModel, java.lang.String, java.lang.String, java.lang.Integer) that indicate a user is ineligible for an action-token email. These are not errors: admin endpoints may translate them into 400 Bad Request, while background executors may silently skip the user.

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
CLIENT_UNAVAILABLE	The resolved client does not exist or is not enabled.
INVALID_REDIRECT_URI	The supplied redirectUri is not valid for the resolved client.
USER_DISABLED	The user account is disabled.
USER_HAS_NO_EMAIL	The user has no email address set.

Method Summary

Modifier and Type	Method	Description
static ActionTokenEmail.Ineligibility	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActionTokenEmail.Ineligibility[]	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

USER_HAS_NO_EMAIL

public static final ActionTokenEmail.Ineligibility USER_HAS_NO_EMAIL

The user has no email address set.

USER_DISABLED

public static final ActionTokenEmail.Ineligibility USER_DISABLED

The user account is disabled.

CLIENT_UNAVAILABLE

public static final ActionTokenEmail.Ineligibility CLIENT_UNAVAILABLE

The resolved client does not exist or is not enabled.

INVALID_REDIRECT_URI

public static final ActionTokenEmail.Ineligibility INVALID_REDIRECT_URI

The supplied redirectUri is not valid for the resolved client.

Method Details

values

public static ActionTokenEmail.Ineligibility[] 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 ActionTokenEmail.Ineligibility 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