Configuration Reference

Version:1.0.0.BUILD-SNAPSHOT

Oauth2 Config Properties

🔗
Table 1. Configuration Properties for RegistrationEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.registration.url

java.lang.String

registration endpoint’s url

🔗
Table 2. Configuration Properties for AuthorizationCodeControllerConfigurationProperties
Property Type Description

micronaut.security.endpoints.authcode.enabled

boolean

Sets whether the {@link AuthorizationCodeController} is enabled. Default value ({@value #DEFAULT_ENABLED}).

micronaut.security.endpoints.authcode.controller-path

java.lang.String

The authorization controller path. Default value ({@value #DEFAULT_CONTROLLERPATH}).

micronaut.security.endpoints.authcode.callback-path

java.lang.String

Sets the path used by OAuth providers to callback the application. The value is appended to the controller path value. Default value ({@value #DEFAULT_CALLBACK}).

micronaut.security.endpoints.authcode.login-path

java.lang.String

Sets the path used to trigger a redirect to login with OAuth. The value is appended to the controller path value. Default value ({@value #DEFAULT_LOGIN}).

🔗
Table 3. Configuration Properties for GrantTypePasswordRequestProviderConfigurationProperties
Property Type Description

micronaut.security.oauth2.grant-type-password.enabled

boolean

Sets whether the {@link GrantTypePasswordRequestProvider} is enabled. Default value ({@value #DEFAULT_ENABLED}).

micronaut.security.oauth2.grant-type-password.content-type

MediaType

The Content-Type used to communicate with the token endpoint.

micronaut.security.oauth2.grant-type-password.scopes

java.util.List

OAuth 2.0 scopes.

🔗
Table 4. Configuration Properties for OauthConfigurationProperties
Property Type Description

micronaut.security.oauth2.client-id

java.lang.String

OAuth 2.0 Application Client ID.

micronaut.security.oauth2.client-secret

java.lang.String

OAuth 2.0 Application Client Secret. Optional.

micronaut.security.oauth2.enabled

boolean

Sets whether the {@link OauthConfiguration} is enabled. Default value ({@value #DEFAULT_ENABLED}).

🔗
Table 5. Configuration Properties for UserInfoEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.user-info.url

java.lang.String

URL of the Open ID Provider’s UserInfo Endpoint. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.

🔗
Table 6. Configuration Properties for DefaultStateValidationConfiguration
Property Type Description

micronaut.security.oauth2.openid.state.validation.persistence

java.lang.String

Sets the mechanism to persist the state for later retrieval for validation. Only "session" is supported by default.

micronaut.security.oauth2.openid.state.validation.enabled

boolean

Sets whether state validation is enabled. Default ({@value #DEFAULT_ENABLED}).

🔗
Table 7. Configuration Properties for CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties
Property Type Description

micronaut.security.oauth2.openid.idtoken.cookie.cookie-name

java.lang.String

Cookie Name. Default value (JWT).

micronaut.security.oauth2.openid.idtoken.cookie.cookie-domain

java.lang.String

Sets the domain name of this Cookie. Default value (JWT).

micronaut.security.oauth2.openid.idtoken.cookie.cookie-path

java.lang.String

Sets the path of the cookie. Default value ({@value #DEFAULT_COOKIEPATH}).

micronaut.security.oauth2.openid.idtoken.cookie.default-redirect-uri

java.net.URI

Sets the login success target URL. Default behavior is to redirect back to the original URI.

micronaut.security.oauth2.openid.idtoken.cookie.redirection-strategy

RedirectionStrategy

Sets the redirection strategy. Default value (original).

micronaut.security.oauth2.openid.idtoken.cookie.cookie-http-only

java.lang.Boolean

Whether the Cookie can only be accessed via HTTP. Default value ({@value #DEFAULT_HTTPONLY}).

micronaut.security.oauth2.openid.idtoken.cookie.cookie-secure

java.lang.Boolean

Sets whether the cookie is secured. Default value ({@value #DEFAULT_SECURE}).

micronaut.security.oauth2.openid.idtoken.cookie.cookie-max-age

java.time.temporal.TemporalAmount

Sets the maximum age of the cookie.

micronaut.security.oauth2.openid.idtoken.cookie.enabled

boolean

Enables CookieSuccessfulIdTokenAccessTokenResponseHandler. Default value ({@value #DEFAULT_ENABLED}).

🔗
Table 8. Configuration Properties for OpenIdProviderConfigurationProperties
Property Type Description

micronaut.security.oauth2.openid.issuer

java.lang.String

URL using the https scheme with no query or fragment component that the Open ID Provider asserts as its Issuer Identifier.

micronaut.security.oauth2.openid.scopes-supported

java.util.List

List of the OAuth 2.0 [RFC6749] scope values that this server supports.

micronaut.security.oauth2.openid.response-types-supported

java.util.List

List of the OAuth 2.0 response_type values that this Open ID Provider supports.

micronaut.security.oauth2.openid.subject-types-supported

java.util.List

List of the Subject Identifier types that this OP supports.

micronaut.security.oauth2.openid.id-token-encryption-enc-values-supported

java.util.List

List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT.

micronaut.security.oauth2.openid.request-object-signing-alg-values-supported

java.util.List

List of the JWS signing algorithms (alg values) supported by the OP for Request Objects.

micronaut.security.oauth2.openid.jwks-uri

java.lang.String

Sets the JWKS uri.

micronaut.security.oauth2.openid.configuration-path

java.lang.String

The configuration path to discover openid configuration. Default ({@value DEFAULT_CONFIG_PATH}).

🔗
Table 9. Configuration Properties for AuthorizationEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.authorization.url

java.lang.String

the authorization endpoint’s url.

micronaut.security.oauth2.authorization.redirect-uri

java.lang.String

Redirection URI to which the response will be sent. Default value (http://localhost:8080/auth/code).

micronaut.security.oauth2.authorization.scopes

java.util.List

Sets OAuth 2.0 scopes. Default value (['openid', 'email', 'profile']).

micronaut.security.oauth2.authorization.response-type

java.lang.String

Set OAuth 2.0 Response Type. Default value ({@value #DEFAULT_RESPONSETYPE}).

micronaut.security.oauth2.authorization.response-mode

java.lang.String

Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint. Default value ({@value #DEFAULT_RESPONSEMODE}).

micronaut.security.oauth2.authorization.display

Display

ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. Default value (null).

micronaut.security.oauth2.authorization.prompt

Prompt

Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent. Default value (null).

micronaut.security.oauth2.authorization.max-age

java.lang.Integer

Maximum Authentication Age. Default value (null).

micronaut.security.oauth2.authorization.ui-locales

java.util.List

End-User’s preferred languages and scripts for the user interface. Default value (null).

micronaut.security.oauth2.authorization.acr-values

java.util.List

Requested Authentication Context Class Reference values. Default value (null).

🔗
Table 10. Configuration Properties for IntrospectionEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.introspection.url

java.lang.String

Introspection endpoint’s url.

🔗
Table 11. Configuration Properties for EndSessionEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.end-session.url

java.lang.String

The end-session endpoint url

micronaut.security.oauth2.end-session.redirect-uri

java.lang.String

Redirection URI to which the response will be sent.

micronaut.security.oauth2.end-session.parameters

java.util.List

End-session endpoint parameters.

🔗
Table 12. Configuration Properties for RevocationEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.revocation.url

java.lang.String

Revocation Endpoint’s url.

🔗
Table 13. Configuration Properties for DeniedControllerConfigurationProperties
Property Type Description

micronaut.security.endpoints.denied.title-copy

java.lang.String

The default copy to be used for the HTML page title. Default value ({@value #DEFAULT_TITLE}).

micronaut.security.endpoints.denied.description-copy

java.lang.String

The default copy to be used for the HTML page description paragraph. Default value ({@value DEFAULT_DESCRIPTION}).

micronaut.security.endpoints.denied.path

java.lang.String

The default route uri of the {@link DeniedController}. Default value ({@value #DEFAULT_PATH}).

🔗
Table 14. Configuration Properties for JwksSignatureFactoryConfigurationProperties
Property Type Description

micronaut.security.oauth2.openid.jwks-signature-factory.enabled

boolean

Enables {@link JwksSignatureFactory}. Default value ({@value #DEFAULT_ENABLED}).

micronaut.security.oauth2.openid.jwks-signature-factory.key-type

com.nimbusds.jose.jwk.KeyType

KeyType for this JWKS signature configuration. Default Value (RSA).

🔗
Table 15. Configuration Properties for EndsessionViewModelProcessorConfigurationProperties
Property Type Description

micronaut.security.oauth2.end-session.view-model-processor.enabled

boolean

Sets whether the {@link EndSessionViewModelProcessor} is enabled. Default value ({@value #DEFAULT_ENABLED}).

micronaut.security.oauth2.end-session.view-model-processor.end-session-url-key

java.lang.String

Model key name. Default value ({@value #DEFAULT_ENDSESSIONURLKEY}).

🔗
Table 16. Configuration Properties for TokenEndpointConfigurationProperties
Property Type Description

micronaut.security.oauth2.token.url

java.lang.String

token endpoint’s url

micronaut.security.oauth2.token.grant-type

java.lang.String

OAuth 2.0 Grant Type. Default value (authorization_code).

micronaut.security.oauth2.token.auth-method

java.lang.String

Client Authentication method. By default no value is specified. In that case, the value returned by AuthMethodProvider, if such a bean exists, is used.

micronaut.security.oauth2.token.content-type

MediaType

The Content-Type used to communicate with the token endpoint. Default value (application/x-www-form-urlencoded).

micronaut.security.oauth2.token.redirect-uri

java.lang.String

Redirection URI to which the response will be sent.