Package net.openid.appauth

Class AuthorizationRequest.Prompt

java.lang.Object

net.openid.appauth.AuthorizationRequest.Prompt

Enclosing class:

AuthorizationRequest

public static final class AuthorizationRequest.Prompt
extends Object

All spec-defined values for the OpenID Connect 1.0 prompt parameter.

See Also:

AuthorizationRequest.Builder.setPrompt(String), “OpenID Connect Core 1.0, Section 3.1.2.1 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.1”

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONSENT	The Authorization Server SHOULD prompt the End-User for consent before returning information to the Client.
static String	LOGIN	The Authorization Server SHOULD prompt the End-User for re-authentication.
static String	NONE	The Authorization Server MUST NOT display any authentication or consent user interface pages.
static String	SELECT_ACCOUNT	The Authorization Server SHOULD prompt the End-User to select a user account.

Constructor Summary

Constructors

Constructor	Description
Prompt()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final String NONE

The Authorization Server MUST NOT display any authentication or consent user interface pages.

An error is returned if an End-User is not already authenticated or the Client does not have pre-configured consent for the requested Claims or does not fulfill other conditions for processing the request. The error code will typically be login_required, interaction_required, or another code defined in OpenID Connect Core 1.0, Section 3.1.2.6. This can be used as a method to check for existing authentication and/or consent.

See Also:

“OpenID Connect Core 1.0, Section 3.1.2.1 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.1”, “OpenID Connect Core 1.0, Section 3.1.2.6 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6”, Constant Field Values

LOGIN

public static final String LOGIN

The Authorization Server SHOULD prompt the End-User for re-authentication.

If it cannot re-authenticate the End-User, it MUST return an error, typically login_required.

See Also:

“OpenID Connect Core 1.0, Section 3.1.2.1 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.1”, “OpenID Connect Core 1.0, Section 3.1.2.6 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6”, Constant Field Values

CONSENT

public static final String CONSENT

The Authorization Server SHOULD prompt the End-User for consent before returning information to the Client.

If it cannot obtain consent, it MUST return an error, typically consent_required.

See Also:

“OpenID Connect Core 1.0, Section 3.1.2.1 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.1”, “OpenID Connect Core 1.0, Section 3.1.2.6 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6”, Constant Field Values

SELECT_ACCOUNT

public static final String SELECT_ACCOUNT

The Authorization Server SHOULD prompt the End-User to select a user account.

This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for. If it cannot obtain an account selection choice made by the End-User, it MUST return an error, typically account_selection_required.

See Also:

“OpenID Connect Core 1.0, Section 3.1.2.1 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.1”, “OpenID Connect Core 1.0, Section 3.1.2.6 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6”, Constant Field Values

Constructor Detail

Prompt

public Prompt()