Package io.micronaut.security.oauth2.configuration

Interface OauthClientConfiguration

All Superinterfaces:

io.micronaut.core.util.Toggleable

All Known Implementing Classes:

OauthClientConfigurationProperties

public interface OauthClientConfiguration
extends io.micronaut.core.util.Toggleable

OAuth 2.0 client configuration.

Since:

1.2.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_ADVANCED_EXPIRATION	The default advanced expiration value for client credentials grant.
static final String	DEFAULT_AUTH_METHOD
static final AuthenticationMethod	DEFAULT_AUTHENTICATION_METHOD	Deprecated, for removal: This API element is subject to removal in a future version. Use DEFAULT_AUTH_METHOD instead.

Method Summary

Modifier and Type	Method	Description
Optional<OauthAuthorizationEndpointConfiguration>	getAuthorization()
@NonNull Optional<ClientCredentialsConfiguration>	getClientCredentials()
@NonNull String	getClientId()
@Nullable String	getClientSecret()
@NonNull GrantType	getGrantType()
Optional<SecureEndpointConfiguration>	getIntrospection()
@NonNull String	getName()
Optional<OpenIdClientConfiguration>	getOpenid()
Optional<SecureEndpointConfiguration>	getRevocation()
@NonNull List<String>	getScopes()
Optional<SecureEndpointConfiguration>	getToken()
default SecureEndpoint	getTokenEndpoint()

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Field Details

DEFAULT_AUTHENTICATION_METHOD

@Deprecated(forRemoval=true)
static final AuthenticationMethod DEFAULT_AUTHENTICATION_METHOD

Deprecated, for removal: This API element is subject to removal in a future version.

Use DEFAULT_AUTH_METHOD instead.

DEFAULT_AUTH_METHOD

static final String DEFAULT_AUTH_METHOD

See Also:

• Constant Field Values

DEFAULT_ADVANCED_EXPIRATION

static final Duration DEFAULT_ADVANCED_EXPIRATION

The default advanced expiration value for client credentials grant.

Method Details

getName

@NonNull
@NonNull String getName()

Returns:

The provider name

getClientId

@NonNull
@NonNull String getClientId()

Returns:

The client id

getClientSecret

@Nullable
@Nullable String getClientSecret()

Returns:

The client secret

getScopes

@NonNull
@NonNull List<String> getScopes()

Returns:

The scopes requested

getGrantType

@NonNull
@NonNull GrantType getGrantType()

Returns:

The grant type

getToken

Optional<SecureEndpointConfiguration> getToken()

Returns:

The optional token endpoint configuration

See Also:

• RFC 6749 Section 4.1.3

getAuthorization

Optional<OauthAuthorizationEndpointConfiguration> getAuthorization()

Returns:

The optional authorization endpoint configuration

See Also:

• RFC 6749 Section 3.1

getClientCredentials

@NonNull
@NonNull Optional<ClientCredentialsConfiguration> getClientCredentials()

Returns:

The Client Credentials Configuration

getIntrospection

Optional<SecureEndpointConfiguration> getIntrospection()

Returns:

The introspection endpoint configuration

See Also:

• RFC 7662

getRevocation

Optional<SecureEndpointConfiguration> getRevocation()

Returns:

The revocation endpoint configuration

See Also:

• RFC 7009

getOpenid

Optional<OpenIdClientConfiguration> getOpenid()

Returns:

The optional OpenID configuration

getTokenEndpoint

default SecureEndpoint getTokenEndpoint()
                                 throws io.micronaut.context.exceptions.ConfigurationException

Returns:

The Token endpoint

Throws:

io.micronaut.context.exceptions.ConfigurationException - if token endpoint url is not set in configuration