Enum AuthorizationFailRequest.Reason
- java.lang.Object
-
- java.lang.Enum<AuthorizationFailRequest.Reason>
-
- com.authlete.common.dto.AuthorizationFailRequest.Reason
-
- All Implemented Interfaces:
Serializable
,Comparable<AuthorizationFailRequest.Reason>
- Enclosing class:
- AuthorizationFailRequest
public static enum AuthorizationFailRequest.Reason extends Enum<AuthorizationFailRequest.Reason>
Failure reasons of authorization requests.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCOUNT_SELECTION_REQUIRED
The authorization server cannot obtain an account selection choice made by the end-user.ACR_NOT_SATISFIED
The authorization request from the client application contained"acr"
claim in"claims"
request parameter and the claim was marked as essential, but the ACR performed for the end-user does not match any one of the requested ACRs.CONSENT_REQUIRED
The authorization server cannot obtain consent from the end-user.DENIED
The end-user denied the authorization request from the client application.DIFFERENT_SUBJECT
The authorization request from the client application requested a specific value forsub
claim, but the current end-user (in the case ofprompt=none
) or the end-user after the authentication is different from the specified value.EXCEEDS_MAX_AGE
The authorization request from the client application containedprompt=none
, but the time specified bymax_age
request parameter or bydefault_max_age
configuration parameter has passed since the time at which the end-user logged in.INTERACTION_REQUIRED
The authorization server needs interaction with the end-user.INVALID_TARGET
The requested resource is invalid, missing, unknown, or malformed.MAX_AGE_NOT_SUPPORTED
The authorization request from the client application containedmax_age
parameter with a non-zero value or the client's configuration has a non-zero value fordefault_max_age
configuration parameter, but the service implementation cannot behave properly based on the max age value mainly because the service implementation does not manage authentication time of end-users.NOT_AUTHENTICATED
The end-user was not authenticated.NOT_LOGGED_IN
The authorization request from the client application containedprompt=none
, but any end-user has not logged in.SERVER_ERROR
Server error.UNKNOWN
Unknown reason.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static AuthorizationFailRequest.Reason
valueOf(String name)
Returns the enum constant of this type with the specified name.static AuthorizationFailRequest.Reason[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNKNOWN
public static final AuthorizationFailRequest.Reason UNKNOWN
Unknown reason.Using this reason will result in
error=server_error
.
-
NOT_LOGGED_IN
public static final AuthorizationFailRequest.Reason NOT_LOGGED_IN
The authorization request from the client application containedprompt=none
, but any end-user has not logged in.See "OpenID Connect Core 1.0, 3.1.2.1. Authentication Request" for
prompt
request parameter.Using this reason will result in
error=login_required
.
-
MAX_AGE_NOT_SUPPORTED
public static final AuthorizationFailRequest.Reason MAX_AGE_NOT_SUPPORTED
The authorization request from the client application containedmax_age
parameter with a non-zero value or the client's configuration has a non-zero value fordefault_max_age
configuration parameter, but the service implementation cannot behave properly based on the max age value mainly because the service implementation does not manage authentication time of end-users.See "OpenID Connect Core 1.0, 3.1.2.1. Authentication Request" for
max_age
request parameter.See "OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata" for
default_max_age
configuration parameter.Using this reason will result in
error=login_required
.
-
EXCEEDS_MAX_AGE
public static final AuthorizationFailRequest.Reason EXCEEDS_MAX_AGE
The authorization request from the client application containedprompt=none
, but the time specified bymax_age
request parameter or bydefault_max_age
configuration parameter has passed since the time at which the end-user logged in.See "OpenID Connect Core 1.0, 3.1.2.1. Authentication Request" for
prompt
andmax_age
request parameters.See "OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata" for
default_max_age
configuration parameter.Using this reason will result in
error=login_required
.
-
DIFFERENT_SUBJECT
public static final AuthorizationFailRequest.Reason DIFFERENT_SUBJECT
The authorization request from the client application requested a specific value forsub
claim, but the current end-user (in the case ofprompt=none
) or the end-user after the authentication is different from the specified value.Using this reason will result in
error=login_required
.
-
ACR_NOT_SATISFIED
public static final AuthorizationFailRequest.Reason ACR_NOT_SATISFIED
The authorization request from the client application contained"acr"
claim in"claims"
request parameter and the claim was marked as essential, but the ACR performed for the end-user does not match any one of the requested ACRs.Using this reason will result in
error=login_required
when the version of your Authlete server is 2.2 or older. Otherwise, this reason will result inerror=unmet_authentication_requirements
. See "OpenID Connect Core Error Code unmet_authentication_requirements" for details aboutunmet_authentication_requirements
.
-
DENIED
public static final AuthorizationFailRequest.Reason DENIED
The end-user denied the authorization request from the client application.Using this reason will result in
error=access_denied
.
-
SERVER_ERROR
public static final AuthorizationFailRequest.Reason SERVER_ERROR
Server error.Using this reason will result in
error=server_error
.- Since:
- 1.3
-
NOT_AUTHENTICATED
public static final AuthorizationFailRequest.Reason NOT_AUTHENTICATED
The end-user was not authenticated.Using this reason will result in
error=login_required
.- Since:
- 1.3
-
ACCOUNT_SELECTION_REQUIRED
public static final AuthorizationFailRequest.Reason ACCOUNT_SELECTION_REQUIRED
The authorization server cannot obtain an account selection choice made by the end-user.Using this reason will result in
error=account_selection_required
.- Since:
- 2.11
-
CONSENT_REQUIRED
public static final AuthorizationFailRequest.Reason CONSENT_REQUIRED
The authorization server cannot obtain consent from the end-user.Using this reason will result in
error=consent_required
.- Since:
- 2.11
-
INTERACTION_REQUIRED
public static final AuthorizationFailRequest.Reason INTERACTION_REQUIRED
The authorization server needs interaction with the end-user.Using this reason will result in
error=interaction_required
.- Since:
- 2.11
-
INVALID_TARGET
public static final AuthorizationFailRequest.Reason INVALID_TARGET
The requested resource is invalid, missing, unknown, or malformed. See "Resource Indicators for OAuth 2.0" for details.Using this reason will result in
error=invalid_target
.- Since:
- 2.62
-
-
Method Detail
-
values
public static AuthorizationFailRequest.Reason[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (AuthorizationFailRequest.Reason c : AuthorizationFailRequest.Reason.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AuthorizationFailRequest.Reason valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-