io.micronaut.security.oauth2.openid.endpoints.authorization

Interface AuthenticationRequest

All Superinterfaces:

AuthorizationEndpointRequestConfiguration

All Known Implementing Classes:

AuthenticationRequestAdapter

public interface AuthenticationRequest
extends AuthorizationEndpointRequestConfiguration

OAuth 2.0 Authorization Request.

See Also:

Authentication Request

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_ACR_VALUES
static java.lang.String	PARAMETER_CLIENT_ID
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_REDIRECT_URI
static java.lang.String	PARAMETER_RESPONSE_MODE
static java.lang.String	PARAMETER_RESPONSE_TYPE
static java.lang.String	PARAMETER_SCOPE
static java.lang.String	PARAMETER_STATE
static java.lang.String	PARAMETER_UI_LOCALES

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId()
java.lang.String	getIdTokenHint()
java.lang.String	getLoginHint()
java.lang.String	getNonce()
java.lang.String	getState()

Methods inherited from interface io.micronaut.security.oauth2.openid.endpoints.authorization.AuthorizationEndpointRequestConfiguration

getAcrValues, getDisplay, getMaxAge, getPrompt, getRedirectUri, getResponseMode, getResponseType, getScopes, getUiLocales

Field Detail

PARAMETER_SCOPE

static final java.lang.String PARAMETER_SCOPE

See Also:

Constant Field Values

PARAMETER_RESPONSE_TYPE

static final java.lang.String PARAMETER_RESPONSE_TYPE

See Also:

Constant Field Values

PARAMETER_CLIENT_ID

static final java.lang.String PARAMETER_CLIENT_ID

See Also:

Constant Field Values

PARAMETER_REDIRECT_URI

static final java.lang.String PARAMETER_REDIRECT_URI

See Also:

Constant Field Values

PARAMETER_STATE

static final java.lang.String PARAMETER_STATE

See Also:

Constant Field Values

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

getClientId

@Nonnull
java.lang.String getClientId()

Returns:

OAuth 2.0 Client Identifier valid at the Authorization Server.

getState

@Nullable
java.lang.String getState()

Returns:

Opaque value used to maintain state between the request and the callback.

getNonce

@Nullable
java.lang.String getNonce()

Returns:

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

getLoginHint

@Nullable
java.lang.String getLoginHint()

Returns:

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

getIdTokenHint

@Nullable
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.