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

Interface AuthorizationRequest

All Known Subinterfaces:

OauthAuthorizationRequest, OpenIdAuthorizationRequest

public interface AuthorizationRequest

OAuth 2.0 Authorization Request.

See Also:

Authentication Request

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_CLIENT_ID
static java.lang.String	PARAMETER_PKCE_CODE_CHALLENGE
static java.lang.String	PARAMETER_PKCE_CODE_CHALLENGE_METHOD
static java.lang.String	PARAMETER_REDIRECT_URI
static java.lang.String	PARAMETER_RESPONSE_TYPE
static java.lang.String	PARAMETER_SCOPE
static java.lang.String	PARAMETER_STATE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId()
default java.util.Optional<PkceChallenge>	getPkceChallenge(io.micronaut.http.MutableHttpResponse<?> response)
java.util.Optional<java.lang.String>	getRedirectUri()
java.lang.String	getResponseType()
java.util.List<java.lang.String>	getScopes()
java.util.Optional<java.lang.String>	getState(io.micronaut.http.MutableHttpResponse<?> response)

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_PKCE_CODE_CHALLENGE

static final java.lang.String PARAMETER_PKCE_CODE_CHALLENGE

See Also:

Constant Field Values

PARAMETER_PKCE_CODE_CHALLENGE_METHOD

static final java.lang.String PARAMETER_PKCE_CODE_CHALLENGE_METHOD

See Also:

Constant Field Values

Method Detail

getScopes

@NonNull
java.util.List<java.lang.String> getScopes()

Returns:

OAuth 2.0 scopes.

getClientId

@NonNull
java.lang.String getClientId()

Returns:

OAuth 2.0 Client Identifier valid at the Authorization Server.

getState

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

Parameters:

response - authorization redirect response

Returns:

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

getResponseType

@NonNull
java.lang.String getResponseType()

Returns:

OAuth 2.0 Response Type value that determines the authorization processing flow to be used, including what parameters are returned from the endpoints used.

getRedirectUri

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

Returns:

Redirection URI to which the response will be sent.

getPkceChallenge

@NonNull
default java.util.Optional<PkceChallenge> getPkceChallenge(@NonNull
                                                                    io.micronaut.http.MutableHttpResponse<?> response)

Parameters:

response - HTTP Response

Returns:

The PCKE challenge

Since:

3.9.0

See Also:

RFC 7636