Package com.nimbusds.openid.connect.sdk

Class OIDCError

java.lang.Object

com.nimbusds.openid.connect.sdk.OIDCError

public final class OIDCError
extends Object

OpenID Connect specific errors.

Related specifications:

• OpenID Connect Core 1.0, section 3.1.2.6.

Field Summary

Fields

Modifier and Type	Field	Description
static ErrorObject	ACCOUNT_SELECTION_REQUIRED	The end-user is required to select a session at the authorisation server.
static String	ACCOUNT_SELECTION_REQUIRED_CODE	The ACCOUNT_SELECTION_REQUIRED error code string.
static ErrorObject	CONSENT_REQUIRED	The authorisation server requires end-user consent.
static String	CONSENT_REQUIRED_CODE	The CONSENT_REQUIRED error code string.
static ErrorObject	INTERACTION_REQUIRED	The authorisation server requires end-user interaction of some form to proceed.
static String	INTERACTION_REQUIRED_CODE	The INTERACTION_REQUIRED error code string.
static ErrorObject	LOGIN_REQUIRED	The authorisation server requires end-user authentication.
static String	LOGIN_REQUIRED_CODE	The LOGIN_REQUIRED error code string.
static ErrorObject	REGISTRATION_NOT_SUPPORTED	The registration parameter in the AuthenticationRequest is not supported.
static String	REGISTRATION_NOT_SUPPORTED_CODE	The REGISTRATION_NOT_SUPPORTED error code string.
static ErrorObject	UNMET_AUTHENTICATION_REQUIREMENTS	The OpenID provider is unable to authenticate the end-user at the required Authentication Context Class Reference value when requested with an essential acr claim.
static String	UNMET_AUTHENTICATION_REQUIREMENTS_CODE	The UNMET_AUTHENTICATION_REQUIREMENTS error code string.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

INTERACTION_REQUIRED_CODE

public static final String INTERACTION_REQUIRED_CODE

The INTERACTION_REQUIRED error code string.

See Also:

Constant Field Values

INTERACTION_REQUIRED

public static final ErrorObject INTERACTION_REQUIRED

The authorisation server requires end-user interaction of some form to proceed. This error may be returned when the Prompt parameter in the AuthenticationRequest is set to none to request that the authorisation server should not display any user interfaces to the end-user, but the AuthenticationRequest cannot be completed without displaying a user interface for end-user interaction.

LOGIN_REQUIRED_CODE

public static final String LOGIN_REQUIRED_CODE

The LOGIN_REQUIRED error code string.

See Also:

Constant Field Values

LOGIN_REQUIRED

public static final ErrorObject LOGIN_REQUIRED

The authorisation server requires end-user authentication. This error may be returned when the prompt parameter in the AuthenticationRequest is set to Prompt.Type.NONE to request that the authorisation server should not display any user interfaces to the end-user, but the AuthenticationRequest cannot be completed without displaying a user interface for user authentication.

ACCOUNT_SELECTION_REQUIRED_CODE

public static final String ACCOUNT_SELECTION_REQUIRED_CODE

The ACCOUNT_SELECTION_REQUIRED error code string.

See Also:

Constant Field Values

ACCOUNT_SELECTION_REQUIRED

public static final ErrorObject ACCOUNT_SELECTION_REQUIRED

The end-user is required to select a session at the authorisation server. The end-user may be authenticated at the authorisation server with different associated accounts, but the end-user did not select a session. This error may be returned when the prompt parameter in the AuthenticationRequest is set to Prompt.Type.NONE to request that the authorisation server should not display any user interfaces to the end-user, but the AuthenticationRequest cannot be completed without displaying a user interface to prompt for a session to use.

CONSENT_REQUIRED_CODE

public static final String CONSENT_REQUIRED_CODE

The CONSENT_REQUIRED error code string.

See Also:

Constant Field Values

CONSENT_REQUIRED

public static final ErrorObject CONSENT_REQUIRED

The authorisation server requires end-user consent. This error may be returned when the prompt parameter in the AuthenticationRequest is set to Prompt.Type.NONE to request that the authorisation server should not display any user interfaces to the end-user, but the AuthenticationRequest cannot be completed without displaying a user interface for end-user consent.

UNMET_AUTHENTICATION_REQUIREMENTS_CODE

public static final String UNMET_AUTHENTICATION_REQUIREMENTS_CODE

The UNMET_AUTHENTICATION_REQUIREMENTS error code string.

See Also:

Constant Field Values

UNMET_AUTHENTICATION_REQUIREMENTS

public static final ErrorObject UNMET_AUTHENTICATION_REQUIREMENTS

The OpenID provider is unable to authenticate the end-user at the required Authentication Context Class Reference value when requested with an essential acr claim. This error code may also be used in other appropriate cases.

REGISTRATION_NOT_SUPPORTED_CODE

public static final String REGISTRATION_NOT_SUPPORTED_CODE

The REGISTRATION_NOT_SUPPORTED error code string.

See Also:

Constant Field Values

REGISTRATION_NOT_SUPPORTED

public static final ErrorObject REGISTRATION_NOT_SUPPORTED

The registration parameter in the AuthenticationRequest is not supported. Applies only to self-issued OpenID providers.