Package com.nimbusds.oauth2.sdk

Class OAuth2Error

java.lang.Object

com.nimbusds.oauth2.sdk.OAuth2Error

public final class OAuth2Error
extends Object

Standard OAuth 2.0 authorisation and token endpoint errors.

The set HTTP status code is ignored for authorisation errors passed by HTTP redirection. Errors that are only used by at the authorisation endpoint are supplied with a matching HTTP status code in case they are used in a different context.

Field Summary

Fields

Modifier and Type	Field	Description
static final ErrorObject	ACCESS_DENIED	The resource owner or authorisation server denied the request.
static final String	ACCESS_DENIED_CODE	The ACCESS_DENIED error code string.
static final ErrorObject	INVALID_AUTHORIZATION_DETAILS	The requested authorisation details are invalid, unknown, or malformed.
static final String	INVALID_AUTHORIZATION_DETAILS_CODE	The INVALID_AUTHORIZATION_DETAILS error code string.
static final ErrorObject	INVALID_CLIENT	Client authentication failed (e.g.
static final String	INVALID_CLIENT_CODE	The INVALID_CLIENT error code string.
static final ErrorObject	INVALID_DPOP_PROOF	The DPoP proof received by the authorisation server is invalid.
static final String	INVALID_DPOP_PROOF_CODE	The USE_DPOP_NONCE error code string.
static final ErrorObject	INVALID_GRANT	The provided authorisation grant (e.g.
static final String	INVALID_GRANT_CODE	The INVALID_GRANT error code string.
static final ErrorObject	INVALID_REQUEST	The request is missing a required parameter, includes an invalid parameter, or is otherwise malformed.
static final String	INVALID_REQUEST_CODE	The INVALID_REQUEST error code string.
static final ErrorObject	INVALID_REQUEST_OBJECT	The request parameter in the AuthorizationRequest contains an invalid request object.
static final String	INVALID_REQUEST_OBJECT_CODE	The INVALID_REQUEST_OBJECT error code string.
static final ErrorObject	INVALID_REQUEST_URI	The request_uri in the AuthorizationRequest returns an error or invalid data.
static final String	INVALID_REQUEST_URI_CODE	The INVALID_REQUEST_URI error code string.
static final ErrorObject	INVALID_RESOURCE	Deprecated.
static final String	INVALID_RESOURCE_CODE	Deprecated.
static final ErrorObject	INVALID_SCOPE	The requested scope is invalid, unknown, or malformed.
static final String	INVALID_SCOPE_CODE	The INVALID_SCOPE error code string.
static final ErrorObject	INVALID_TARGET	The specified resource server URI is not valid or accepted by the authorisation server.
static final String	INVALID_TARGET_CODE	The INVALID_RESOURCE error code string.
static final ErrorObject	MISSING_TRUST_ANCHOR	No trusted anchor could be found to process an OpenID Connect Federation 1.0 authorisation request using automatic client registration.
static final String	MISSING_TRUST_ANCHOR_CODE	The MISSING_TRUST_ANCHOR error code string.
static final ErrorObject	OVERBROAD_SCOPE	The scope of the request is considered overbroad by the authorisation server.
static final String	OVERBROAD_SCOPE_CODE	The OVERBROAD_SCOPE error code string.
static final ErrorObject	REQUEST_NOT_SUPPORTED	The request parameter in the AuthorizationRequest is not supported.
static final String	REQUEST_NOT_SUPPORTED_CODE	The REQUEST_NOT_SUPPORTED error code string.
static final ErrorObject	REQUEST_URI_NOT_SUPPORTED	The request_uri parameter in the AuthorizationRequest is not supported.
static final String	REQUEST_URI_NOT_SUPPORTED_CODE	The REQUEST_URI_NOT_SUPPORTED error code string.
static final ErrorObject	SERVER_ERROR	The authorisation server encountered an unexpected condition which prevented it from fulfilling the request.
static final String	SERVER_ERROR_CODE	The SERVER_ERROR error code string.
static final ErrorObject	TEMPORARILY_UNAVAILABLE	The authorisation server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
static final String	TEMPORARILY_UNAVAILABLE_CODE	The TEMPORARILY_UNAVAILABLE error code string.
static final ErrorObject	UNAUTHORIZED_CLIENT	The client is not authorised to request an authorisation code using this method.
static final String	UNAUTHORIZED_CLIENT_CODE	The UNAUTHORIZED_CLIENT error code string.
static final ErrorObject	UNSUPPORTED_GRANT_TYPE	The authorisation grant type is not supported by the authorisation server.
static final String	UNSUPPORTED_GRANT_TYPE_CODE	The UNSUPPORTED_GRANT_TYPE error code string.
static final ErrorObject	UNSUPPORTED_PARAMETER	Unsupported parameter.
static final String	UNSUPPORTED_PARAMETER_CODE	The UNSUPPORTED_PARAMETER error code string.
static final ErrorObject	UNSUPPORTED_RESPONSE_TYPE	The authorisation server does not support obtaining an authorisation code using this method.
static final String	UNSUPPORTED_RESPONSE_TYPE_CODE	The UNSUPPORTED_RESPONSE_TYPE error code string.
static final ErrorObject	USE_DPOP_NONCE	Use of DPoP nonce required.
static final String	USE_DPOP_NONCE_CODE	The USE_DPOP_NONCE error code string.
static final ErrorObject	VALIDATION_FAILED	The trust chain validation for an OpenID Connect Federation 1.0 authorisation request using automatic client registration failed.
static final String	VALIDATION_FAILED_CODE	The VALIDATION_FAILED error code string.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

INVALID_REQUEST_CODE

public static final String INVALID_REQUEST_CODE

The INVALID_REQUEST error code string.

See Also:

• Constant Field Values

INVALID_REQUEST

public static final ErrorObject INVALID_REQUEST

The request is missing a required parameter, includes an invalid parameter, or is otherwise malformed.

UNAUTHORIZED_CLIENT_CODE

public static final String UNAUTHORIZED_CLIENT_CODE

The UNAUTHORIZED_CLIENT error code string.

See Also:

• Constant Field Values

UNAUTHORIZED_CLIENT

public static final ErrorObject UNAUTHORIZED_CLIENT

The client is not authorised to request an authorisation code using this method.

ACCESS_DENIED_CODE

public static final String ACCESS_DENIED_CODE

The ACCESS_DENIED error code string.

See Also:

• Constant Field Values

ACCESS_DENIED

public static final ErrorObject ACCESS_DENIED

The resource owner or authorisation server denied the request.

UNSUPPORTED_RESPONSE_TYPE_CODE

public static final String UNSUPPORTED_RESPONSE_TYPE_CODE

The UNSUPPORTED_RESPONSE_TYPE error code string.

See Also:

• Constant Field Values

UNSUPPORTED_RESPONSE_TYPE

public static final ErrorObject UNSUPPORTED_RESPONSE_TYPE

The authorisation server does not support obtaining an authorisation code using this method.

INVALID_SCOPE_CODE

public static final String INVALID_SCOPE_CODE

The INVALID_SCOPE error code string.

See Also:

• Constant Field Values

INVALID_SCOPE

public static final ErrorObject INVALID_SCOPE

The requested scope is invalid, unknown, or malformed.

INVALID_AUTHORIZATION_DETAILS_CODE

public static final String INVALID_AUTHORIZATION_DETAILS_CODE

The INVALID_AUTHORIZATION_DETAILS error code string.

See Also:

• Constant Field Values

INVALID_AUTHORIZATION_DETAILS

public static final ErrorObject INVALID_AUTHORIZATION_DETAILS

The requested authorisation details are invalid, unknown, or malformed.

SERVER_ERROR_CODE

public static final String SERVER_ERROR_CODE

The SERVER_ERROR error code string.

See Also:

• Constant Field Values

SERVER_ERROR

public static final ErrorObject SERVER_ERROR

The authorisation server encountered an unexpected condition which prevented it from fulfilling the request.

TEMPORARILY_UNAVAILABLE_CODE

public static final String TEMPORARILY_UNAVAILABLE_CODE

The TEMPORARILY_UNAVAILABLE error code string.

See Also:

• Constant Field Values

TEMPORARILY_UNAVAILABLE

public static final ErrorObject TEMPORARILY_UNAVAILABLE

The authorisation server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

INVALID_CLIENT_CODE

public static final String INVALID_CLIENT_CODE

The INVALID_CLIENT error code string.

See Also:

• Constant Field Values

INVALID_CLIENT

public static final ErrorObject INVALID_CLIENT

Client authentication failed (e.g. unknown client, no client authentication included, or unsupported authentication method).

INVALID_GRANT_CODE

public static final String INVALID_GRANT_CODE

The INVALID_GRANT error code string.

See Also:

• Constant Field Values

INVALID_GRANT

public static final ErrorObject INVALID_GRANT

The provided authorisation grant (e.g. authorisation code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.

UNSUPPORTED_GRANT_TYPE_CODE

public static final String UNSUPPORTED_GRANT_TYPE_CODE

The UNSUPPORTED_GRANT_TYPE error code string.

See Also:

• Constant Field Values

UNSUPPORTED_GRANT_TYPE

public static final ErrorObject UNSUPPORTED_GRANT_TYPE

The authorisation grant type is not supported by the authorisation server.

INVALID_REQUEST_URI_CODE

public static final String INVALID_REQUEST_URI_CODE

The INVALID_REQUEST_URI error code string.

See Also:

• Constant Field Values

INVALID_REQUEST_URI

public static final ErrorObject INVALID_REQUEST_URI

The request_uri in the AuthorizationRequest returns an error or invalid data.

INVALID_REQUEST_OBJECT_CODE

public static final String INVALID_REQUEST_OBJECT_CODE

The INVALID_REQUEST_OBJECT error code string.

See Also:

• Constant Field Values

INVALID_REQUEST_OBJECT

public static final ErrorObject INVALID_REQUEST_OBJECT

The request parameter in the AuthorizationRequest contains an invalid request object.

REQUEST_URI_NOT_SUPPORTED_CODE

public static final String REQUEST_URI_NOT_SUPPORTED_CODE

The REQUEST_URI_NOT_SUPPORTED error code string.

See Also:

• Constant Field Values

REQUEST_URI_NOT_SUPPORTED

public static final ErrorObject REQUEST_URI_NOT_SUPPORTED

The request_uri parameter in the AuthorizationRequest is not supported.

REQUEST_NOT_SUPPORTED_CODE

public static final String REQUEST_NOT_SUPPORTED_CODE

The REQUEST_NOT_SUPPORTED error code string.

See Also:

• Constant Field Values

REQUEST_NOT_SUPPORTED

public static final ErrorObject REQUEST_NOT_SUPPORTED

The request parameter in the AuthorizationRequest is not supported.

INVALID_RESOURCE_CODE

@Deprecated
public static final String INVALID_RESOURCE_CODE

Deprecated.

The INVALID_RESOURCE error code string.

See Also:

• INVALID_TARGET_CODE
• Constant Field Values

INVALID_RESOURCE

@Deprecated
public static final ErrorObject INVALID_RESOURCE

Deprecated.

The specified resource server URI is not valid or accepted by the authorisation server. @see #INVALID_TARGET

INVALID_TARGET_CODE

public static final String INVALID_TARGET_CODE

The INVALID_RESOURCE error code string.

See Also:

• Constant Field Values

INVALID_TARGET

public static final ErrorObject INVALID_TARGET

The specified resource server URI is not valid or accepted by the authorisation server.

OVERBROAD_SCOPE_CODE

public static final String OVERBROAD_SCOPE_CODE

The OVERBROAD_SCOPE error code string.

See Also:

• Constant Field Values

OVERBROAD_SCOPE

public static final ErrorObject OVERBROAD_SCOPE

The scope of the request is considered overbroad by the authorisation server.

INVALID_DPOP_PROOF_CODE

public static final String INVALID_DPOP_PROOF_CODE

The USE_DPOP_NONCE error code string.

See Also:

• Constant Field Values

INVALID_DPOP_PROOF

public static final ErrorObject INVALID_DPOP_PROOF

The DPoP proof received by the authorisation server is invalid.

USE_DPOP_NONCE_CODE

public static final String USE_DPOP_NONCE_CODE

The USE_DPOP_NONCE error code string.

See Also:

• Constant Field Values

USE_DPOP_NONCE

public static final ErrorObject USE_DPOP_NONCE

Use of DPoP nonce required.

MISSING_TRUST_ANCHOR_CODE

public static final String MISSING_TRUST_ANCHOR_CODE

The MISSING_TRUST_ANCHOR error code string.

See Also:

• Constant Field Values

MISSING_TRUST_ANCHOR

public static final ErrorObject MISSING_TRUST_ANCHOR

No trusted anchor could be found to process an OpenID Connect Federation 1.0 authorisation request using automatic client registration.

VALIDATION_FAILED_CODE

public static final String VALIDATION_FAILED_CODE

The VALIDATION_FAILED error code string.

See Also:

• Constant Field Values

VALIDATION_FAILED

public static final ErrorObject VALIDATION_FAILED

The trust chain validation for an OpenID Connect Federation 1.0 authorisation request using automatic client registration failed.

UNSUPPORTED_PARAMETER_CODE

public static final String UNSUPPORTED_PARAMETER_CODE

The UNSUPPORTED_PARAMETER error code string.

See Also:

• Constant Field Values

UNSUPPORTED_PARAMETER

public static final ErrorObject UNSUPPORTED_PARAMETER

Unsupported parameter.