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 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:

    • 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:

    • getAuthorization

      Optional<OauthAuthorizationEndpointConfiguration> getAuthorization()
      Returns:
      The optional authorization endpoint configuration
      See Also:

    • getClientCredentials

      @NonNull @NonNull Optional<ClientCredentialsConfiguration> getClientCredentials()
      Returns:
      The Client Credentials Configuration

    • getIntrospection

      Optional<SecureEndpointConfiguration> getIntrospection()
      Returns:
      The introspection endpoint configuration
      See Also:

    • getRevocation

      Optional<SecureEndpointConfiguration> getRevocation()
      Returns:
      The revocation endpoint configuration
      See Also:

    • 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

    • getAuthorizationServer

      @Nullable default @Nullable AuthorizationServer getAuthorizationServer()
      Returns:
      The AuthorizationServer used by the OAuth Client.
      Since:
      4.15.0

    • isProxyWellKnownOauthAuthorizationServer

      default boolean isProxyWellKnownOauthAuthorizationServer()
      Returns:
      Whether a request to /.well-known/oauth-authorization-server should be proxied to the authorization server.
      Since:
      4.15.0

    • isProxyWellKnownOpenidConfiguration

      default boolean isProxyWellKnownOpenidConfiguration()
      Returns:
      Whether a request to /.well-known/openid-configuration should be proxied to the authorization server.
      Since:
      4.15.0