Package io.micronaut.security.oauth2.configuration

Class OauthConfigurationProperties

  • All Implemented Interfaces:
    io.micronaut.core.util.Toggleable, OauthConfiguration
    @Requires(property="micronaut.security.oauth2.enabled",
          value="true",
          defaultValue="true")
@ConfigurationProperties("micronaut.security.oauth2")
public class OauthConfigurationProperties
extends java.lang.Object
implements OauthConfiguration
    ConfigurationProperties implementation of OauthClientConfiguration.
    Since:
    1.2.0
    Author:
    Sergio del Amo

    • Constructor Detail

      • OauthConfigurationProperties

        public OauthConfigurationProperties()

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Specified by:
        isEnabled in interface io.micronaut.core.util.Toggleable

      • setEnabled

        public void setEnabled​(boolean enabled)
        Sets whether the OAuth 2.0 support is enabled. Default value (false).
        Parameters:
        enabled - True if is enabled

      • getLoginUri

        @Nonnull
public java.lang.String getLoginUri()
        Specified by:
        getLoginUri in interface OauthConfiguration
        Returns:
        the login Uri

      • setLoginUri

        public void setLoginUri​(@Nonnull
                        java.lang.String loginUri)
        The URI template that is used to initiate an OAuth 2.0 authorization code grant flow. Default value ("/oauth/login{/provider}").
        Parameters:
        loginUri - The Login uri

      • setDefaultProvider

        public void setDefaultProvider​(java.lang.String defaultProvider)
        The default authentication provider for an OAuth 2.0 authorization code grant flow.
        Parameters:
        defaultProvider - The default authentication provider

      • getDefaultProvider

        @Nullable
public java.util.Optional<java.lang.String> getDefaultProvider()
        Specified by:
        getDefaultProvider in interface OauthConfiguration
        Returns:
        the default authorization provider

      • setCallbackUri

        public void setCallbackUri​(@Nonnull
                           java.lang.String callbackUri)
        The URI template that OAuth 2.0 providers can use to submit an authorization callback request. Default value ("/oauth/callback{/provider}").
        Parameters:
        callbackUri - The callback Uri