io.micronaut.security.oauth2.endpoint.authorization.request

Interface OpenIdAuthorizationRequest

All Superinterfaces:

AuthorizationRequest

public interface OpenIdAuthorizationRequest
extends AuthorizationRequest

The OpenID extensions to the standard OAuth 2.0 authorization request.

Since:

1.2.0

Author:

James Kleeh

See Also:

OpenID Authorization Request

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_ACR_VALUES
static java.lang.String	PARAMETER_DISPLAY
static java.lang.String	PARAMETER_ID_TOKEN_HINT
static java.lang.String	PARAMETER_LOGIN_HINT
static java.lang.String	PARAMETER_MAX_AGE
static java.lang.String	PARAMETER_NONCE
static java.lang.String	PARAMETER_PROMPT
static java.lang.String	PARAMETER_RESPONSE_MODE
static java.lang.String	PARAMETER_UI_LOCALES

Fields inherited from interface io.micronaut.security.oauth2.endpoint.authorization.request.AuthorizationRequest

PARAMETER_CLIENT_ID, PARAMETER_PKCE_CODE_CHALLENGE, PARAMETER_PKCE_CODE_CHALLENGE_METHOD, PARAMETER_REDIRECT_URI, PARAMETER_RESPONSE_TYPE, PARAMETER_SCOPE, PARAMETER_STATE

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.util.List<java.lang.String>>	getAcrValues()
java.util.Optional<Display>	getDisplay()
java.util.Optional<java.lang.String>	getIdTokenHint()
java.util.Optional<java.lang.String>	getLoginHint()
java.util.Optional<java.lang.Integer>	getMaxAge()
java.util.Optional<java.lang.String>	getNonce(io.micronaut.http.MutableHttpResponse response)
java.util.Optional<Prompt>	getPrompt()
java.util.Optional<java.lang.String>	getResponseMode()
java.util.Optional<java.util.List<java.lang.String>>	getUiLocales()

Methods inherited from interface io.micronaut.security.oauth2.endpoint.authorization.request.AuthorizationRequest

getClientId, getPkceChallenge, getRedirectUri, getResponseType, getScopes, getState

Field Detail

PARAMETER_RESPONSE_MODE

static final java.lang.String PARAMETER_RESPONSE_MODE

See Also:

Constant Field Values

PARAMETER_NONCE

static final java.lang.String PARAMETER_NONCE

See Also:

Constant Field Values

PARAMETER_DISPLAY

static final java.lang.String PARAMETER_DISPLAY

See Also:

Constant Field Values

PARAMETER_PROMPT

static final java.lang.String PARAMETER_PROMPT

See Also:

Constant Field Values

PARAMETER_MAX_AGE

static final java.lang.String PARAMETER_MAX_AGE

See Also:

Constant Field Values

PARAMETER_UI_LOCALES

static final java.lang.String PARAMETER_UI_LOCALES

See Also:

Constant Field Values

PARAMETER_ID_TOKEN_HINT

static final java.lang.String PARAMETER_ID_TOKEN_HINT

See Also:

Constant Field Values

PARAMETER_LOGIN_HINT

static final java.lang.String PARAMETER_LOGIN_HINT

See Also:

Constant Field Values

PARAMETER_ACR_VALUES

static final java.lang.String PARAMETER_ACR_VALUES

See Also:

Constant Field Values

Method Detail

getNonce

java.util.Optional<java.lang.String> getNonce(io.micronaut.http.MutableHttpResponse response)

Parameters:

response - The authorization redirect response

Returns:

String value used to associate a Client session with an ID Token, and to mitigate replay attacks.

getLoginHint

java.util.Optional<java.lang.String> getLoginHint()

Returns:

Hint to the Authorization Server about the login identifier the End-User might use to log in.

getIdTokenHint

java.util.Optional<java.lang.String> getIdTokenHint()

Returns:

Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client. If the End-User identified by the ID Token is logged in or is logged in by the request, then the Authorization Server returns a positive response; otherwise, it SHOULD return an error, such as login_required.

getResponseMode

java.util.Optional<java.lang.String> getResponseMode()

Returns:

Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint.

getDisplay

java.util.Optional<Display> getDisplay()

Returns:

ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.

getPrompt

java.util.Optional<Prompt> getPrompt()

Returns:

Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.

getMaxAge

java.util.Optional<java.lang.Integer> getMaxAge()

Returns:

Maximum Authentication Age.

getUiLocales

java.util.Optional<java.util.List<java.lang.String>> getUiLocales()

Returns:

End-User's preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference.

getAcrValues

java.util.Optional<java.util.List<java.lang.String>> getAcrValues()

Returns:

Requested Authentication Context Class Reference values.