diff --git a/snapshot/api/io/micronaut/security/authentication/UsernamePasswordCredentials.html b/snapshot/api/io/micronaut/security/authentication/UsernamePasswordCredentials.html index 9aae29c0f1..8302cf7a9d 100644 --- a/snapshot/api/io/micronaut/security/authentication/UsernamePasswordCredentials.html +++ b/snapshot/api/io/micronaut/security/authentication/UsernamePasswordCredentials.html @@ -110,8 +110,8 @@

Constructor Summary

Default constructor.
-
UsernamePasswordCredentials(@Nullable String username, - @Nullable String password)
+
UsernamePasswordCredentials(String username, + String password)
 
@@ -182,10 +182,8 @@

Constructor Details

UsernamePasswordCredentials

@Creator -public UsernamePasswordCredentials(@Nullable - @Nullable String username, - @Nullable - @Nullable String password)
+public UsernamePasswordCredentials(String username, + String password)
Parameters:
username - e.g. admin
diff --git a/snapshot/api/serialized-form.html b/snapshot/api/serialized-form.html index b3adeb3606..00180b4dd7 100644 --- a/snapshot/api/serialized-form.html +++ b/snapshot/api/serialized-form.html @@ -181,11 +181,11 @@

Serialized Fields

diff --git a/snapshot/guide/configurationreference.html b/snapshot/guide/configurationreference.html index e2bc1d36b3..0bb66dc2ed 100644 --- a/snapshot/guide/configurationreference.html +++ b/snapshot/guide/configurationreference.html @@ -51,9 +51,9 @@

Configuration Reference

Micronaut Security Config Properties

-🔗 +🔗 - +@@ -68,41 +68,31 @@

Micronaut Security Config Propert

- - - + + + - + - - - - - - - + + - - - - - - + - +
Table 1. Configuration Properties for TokenPropagationConfigurationPropertiesTable 1. Configuration Properties for TokenConfigurationProperties

micronaut.security.token.propagation.service-id-regex

java.lang.String

micronaut.security.token.enabled

boolean

Sets whether the configuration is enabled. Default value true.

micronaut.security.token.propagation.uri-regex

micronaut.security.token.roles-name

java.lang.String

micronaut.security.token.propagation.service-id-pattern

java.util.regex.Pattern

micronaut.security.token.propagation.uri-pattern

java.util.regex.Pattern

micronaut.security.token.name-key

java.lang.String

micronaut.security.token.propagation.enabled

boolean

Enables TokenPropagationHttpClientFilter. Default value false

micronaut.security.token.propagation.path

micronaut.security.token.roles-separator

java.lang.String

If the entry used for the roles in the Authentication attributes map is a String, you can use the separator to split its value into multiple roles. Default value DEFAULT_ROLES_SEPARATOR.
-🔗 +🔗 - +@@ -117,38 +107,51 @@

Micronaut Security Config Propert

- + - + - - - + + + - - - + + + - - - + + + - + + + + + + - + + + + + + + + + + +
Table 2. Configuration Properties for RedirectConfigurationPropertiesTable 2. Configuration Properties for RefreshTokenCookieConfigurationProperties

micronaut.security.redirect.login-success

micronaut.security.token.refresh.cookie.cookie-domain

java.lang.String

Where the user is redirected to after a successful login. Default value ("/").

micronaut.security.redirect.login-failure

java.lang.String

Where the user is redirected to after a failed login. Default value ("/").

micronaut.security.token.refresh.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.redirect.logout

java.lang.String

URL where the user is redirected after logout. Default value ("/").

micronaut.security.token.refresh.cookie.cookie-secure

java.lang.Boolean

micronaut.security.redirect.prior-to-login

boolean

If true, the user should be redirected back to the unauthorized - request that initiated the login flow. Supersedes the <code>login-success</code> - configuration for those cases. Default value false.

micronaut.security.token.refresh.cookie.cookie-max-age

java.time.Duration

micronaut.security.redirect.enabled

micronaut.security.token.refresh.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.token.refresh.cookie.enabled

boolean

Sets whether Redirection configuration enabled. Default value (true).

micronaut.security.token.refresh.cookie.cookie-name

java.lang.String

micronaut.security.token.refresh.cookie.cookie-path

java.lang.String
-🔗 +🔗 - +@@ -163,21 +166,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 3. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationPropertiesTable 3. Configuration Properties for SecurityFilterConfigurationProperties

micronaut.security.redirect.forbidden.url

java.lang.String

Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/").

micronaut.security.filter.enabled

boolean

micronaut.security.redirect.forbidden.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).

micronaut.security.filter.path

java.lang.String

Pattern the {@link SecurityFilter} should match. Default value /**. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED
-🔗 +🔗 - +@@ -192,26 +195,41 @@

Micronaut Security Config Propert

- - - + + + - + - + - + + + + + + + + + + + + + + + + - +
Table 4. Configuration Properties for BearerTokenConfigurationPropertiesTable 4. Configuration Properties for TokenPropagationConfigurationProperties

micronaut.security.token.bearer.enabled

boolean

Set whether to enable bearer token authentication. Default value true.

micronaut.security.token.propagation.service-id-regex

java.lang.String

micronaut.security.token.bearer.prefix

micronaut.security.token.propagation.uri-regex

java.lang.String

Sets the prefix to use for the auth token. Default value Bearer.

micronaut.security.token.bearer.header-name

micronaut.security.token.propagation.service-id-pattern

java.util.regex.Pattern

micronaut.security.token.propagation.uri-pattern

java.util.regex.Pattern

micronaut.security.token.propagation.enabled

boolean

Enables TokenPropagationHttpClientFilter. Default value false

micronaut.security.token.propagation.path

java.lang.String

Sets the header name to use. Default value Authorization.
-🔗 +🔗 - +@@ -226,21 +244,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 5. Configuration Properties for SecurityFilterConfigurationPropertiesTable 5. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationProperties

micronaut.security.filter.enabled

boolean

micronaut.security.redirect.refresh.url

java.lang.String

Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/").

micronaut.security.filter.path

java.lang.String

Pattern the {@link SecurityFilter} should match. Default value /**. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED

micronaut.security.redirect.refresh.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).
-🔗 +🔗 - +@@ -255,51 +273,38 @@

Micronaut Security Config Propert

- + - - - - - - - - - - - + - - - + + + - - - + + + - + - - - - - - + - - - + + +
Table 6. Configuration Properties for TokenCookieConfigurationPropertiesTable 6. Configuration Properties for RedirectConfigurationProperties

micronaut.security.token.cookie.cookie-domain

micronaut.security.redirect.login-success

java.lang.String

micronaut.security.token.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.token.cookie.cookie-secure

java.lang.Boolean

Where the user is redirected to after a successful login. Default value ("/").

micronaut.security.token.cookie.cookie-max-age

java.time.Duration

micronaut.security.redirect.login-failure

java.lang.String

Where the user is redirected to after a failed login. Default value ("/").

micronaut.security.token.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.redirect.logout

java.lang.String

URL where the user is redirected after logout. Default value ("/").

micronaut.security.token.cookie.enabled

micronaut.security.redirect.prior-to-login

boolean

Whether JWT cookie configuration is enabled. Default value (true).

micronaut.security.token.cookie.cookie-name

java.lang.String

Cookie Name. Default value ("JWT").

If true, the user should be redirected back to the unauthorized + request that initiated the login flow. Supersedes the <code>login-success</code> + configuration for those cases. Default value false.

micronaut.security.token.cookie.cookie-path

java.lang.String

The path of the cookie. Default value ("/").

micronaut.security.redirect.enabled

boolean

Sets whether Redirection configuration enabled. Default value (true).
-🔗 +🔗 - +@@ -314,31 +319,16 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - + - +
Table 7. Configuration Properties for OauthControllerConfigurationPropertiesTable 7. Configuration Properties for BasicAuthAuthenticationConfiguration

micronaut.security.endpoints.oauth.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.oauth.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.oauth.path

java.lang.String

Sets the path to map the {@link OauthController} to. Default value ("/oauth/access_token").

micronaut.security.endpoints.oauth.get-allowed

micronaut.security.basic-auth.enabled

boolean

Enables the {@link BasicAuthAuthenticationFetcher}. Default value true.
-🔗 +🔗 - +@@ -353,21 +343,26 @@

Micronaut Security Config Propert

- + + + + + + - + - - - + + +
Table 8. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationPropertiesTable 8. Configuration Properties for HttpHeaderTokenPropagatorConfigurationProperties

micronaut.security.redirect.refresh.url

micronaut.security.token.propagation.header.enabled

boolean

Enable HttpHeaderTokenPropagator. Default value (true).

micronaut.security.token.propagation.header.prefix

java.lang.String

Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/").

micronaut.security.redirect.refresh.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).

micronaut.security.token.propagation.header.header-name

java.lang.String
-🔗 +🔗 - +@@ -382,16 +377,21 @@

Micronaut Security Config Propert

- + + + + + + - +
Table 9. Configuration Properties for BasicAuthAuthenticationConfigurationTable 9. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationProperties

micronaut.security.basic-auth.enabled

micronaut.security.redirect.unauthorized.url

java.lang.String

Where the user is redirected to after trying to access a secured route. Default value ("/").

micronaut.security.redirect.unauthorized.enabled

boolean

Enables the {@link BasicAuthAuthenticationFetcher}. Default value true.

Whether it should redirect on unauthorized rejections. Default value (true).
-🔗 +🔗 - +@@ -406,24 +406,40 @@

Micronaut Security Config Propert

- + + + + + + - + - - - + + + - - - + + + - - - + + + + + + + + + + + + +
Table 10. Configuration Properties for TokenConfigurationPropertiesTable 10. Configuration Properties for SecurityConfigurationProperties

micronaut.security.token.enabled

micronaut.security.authentication

AuthenticationMode

Defines which authentication to use. Defaults to null. Possible values bearer, session, cookie, idtoken. Should + only be supplied if the service handles login and logout requests.

micronaut.security.enabled

boolean

Sets whether the configuration is enabled. Default value true.

If Security is enabled. Default value true

micronaut.security.token.roles-name

java.lang.String

micronaut.security.intercept-url-map

java.util.List

Map that defines the interception patterns.

micronaut.security.token.name-key

java.lang.String

micronaut.security.ip-patterns

java.util.List

Allowed IP patterns. Default value (["0.0.0.0"])

micronaut.security.token.roles-separator

java.lang.String

If the entry used for the roles in the Authentication attributes map is a String, you can use the separator to split its value into multiple roles. Default value DEFAULT_ROLES_SEPARATOR.

micronaut.security.intercept-url-map-prepend-pattern-with-context-path

boolean

Whether the intercept URL patterns should be prepended with context path if defined. Defaults to true.

micronaut.security.authentication-provider-strategy

AuthenticationStrategy

Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL.

micronaut.security.reject-not-found

boolean

Whether the server should respond with 401 for requests that do not match any routes on the server, if you set it to false, it will return 404 for requests that do not match any routes on the server. Default value (true).
@@ -457,9 +473,9 @@

Micronaut Security Config Propert
-🔗 +🔗 - +@@ -474,51 +490,85 @@

Micronaut Security Config Propert

- + + + + + + + + + + + + + + + +
Table 12. Configuration Properties for RefreshTokenCookieConfigurationPropertiesTable 12. Configuration Properties for LoginControllerConfigurationProperties

micronaut.security.token.refresh.cookie.cookie-domain

micronaut.security.endpoints.login.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.login.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.login.path

java.lang.String

Path to the controller.

+
+🔗 + + +++++ + + + + + + + + + + - + - + - + - + - + - + - + - + - + - +
Table 13. Configuration Properties for TokenCookieConfigurationProperties
PropertyTypeDescription

micronaut.security.token.cookie.cookie-domain

java.lang.String

micronaut.security.token.refresh.cookie.cookie-http-only

micronaut.security.token.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.token.refresh.cookie.cookie-secure

micronaut.security.token.cookie.cookie-secure

java.lang.Boolean

micronaut.security.token.refresh.cookie.cookie-max-age

micronaut.security.token.cookie.cookie-max-age

java.time.Duration

micronaut.security.token.refresh.cookie.cookie-same-site

micronaut.security.token.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.token.refresh.cookie.enabled

micronaut.security.token.cookie.enabled

boolean

Whether JWT cookie configuration is enabled. Default value (true).

micronaut.security.token.refresh.cookie.cookie-name

micronaut.security.token.cookie.cookie-name

java.lang.String

Cookie Name. Default value ("JWT").

micronaut.security.token.refresh.cookie.cookie-path

micronaut.security.token.cookie.cookie-path

java.lang.String

The path of the cookie. Default value ("/").
-🔗 +🔗 - +@@ -533,26 +583,31 @@

Micronaut Security Config Propert

- + + + + + + - + - + - + - - + +
Table 13. Configuration Properties for HttpHeaderTokenPropagatorConfigurationPropertiesTable 14. Configuration Properties for OauthControllerConfigurationProperties

micronaut.security.token.propagation.header.enabled

micronaut.security.endpoints.oauth.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.oauth.enabled

boolean

Enable HttpHeaderTokenPropagator. Default value (true).

Whether the controller is enabled.

micronaut.security.token.propagation.header.prefix

micronaut.security.endpoints.oauth.path

java.lang.String

Sets the path to map the {@link OauthController} to. Default value ("/oauth/access_token").

micronaut.security.token.propagation.header.header-name

java.lang.String

micronaut.security.endpoints.oauth.get-allowed

boolean
-🔗 +🔗 - +@@ -567,21 +622,16 @@

Micronaut Security Config Propert

- - - - - - - - + + +
Table 14. Configuration Properties for IntrospectionConfigurationPropertiesTable 15. Configuration Properties for AccessTokenConfigurationProperties

micronaut.security.endpoints.introspection.enabled

boolean

micronaut.security.endpoints.introspection.path

java.lang.String

Path to the IntrospectionController. Default value "/token_info"

micronaut.security.token.generator.access-token.expiration

java.lang.Integer

Access token expiration. Default value (3600).
-🔗 +🔗 - +@@ -596,26 +646,21 @@

Micronaut Security Config Propert

- - - - - - + - + - + - +
Table 15. Configuration Properties for LoginControllerConfigurationPropertiesTable 16. Configuration Properties for IntrospectionConfigurationProperties

micronaut.security.endpoints.login.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.login.enabled

micronaut.security.endpoints.introspection.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.login.path

micronaut.security.endpoints.introspection.path

java.lang.String

Path to the controller.

Path to the IntrospectionController. Default value "/token_info"
-🔗 +🔗 - +@@ -630,47 +675,26 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - - - - - - + - + - - - + + + - - - + + +
Table 16. Configuration Properties for SecurityConfigurationPropertiesTable 17. Configuration Properties for BearerTokenConfigurationProperties

micronaut.security.authentication

AuthenticationMode

Defines which authentication to use. Defaults to null. Possible values bearer, session, cookie, idtoken. Should - only be supplied if the service handles login and logout requests.

micronaut.security.enabled

boolean

If Security is enabled. Default value true

micronaut.security.intercept-url-map

java.util.List

Map that defines the interception patterns.

micronaut.security.ip-patterns

java.util.List

Allowed IP patterns. Default value (["0.0.0.0"])

micronaut.security.intercept-url-map-prepend-pattern-with-context-path

micronaut.security.token.bearer.enabled

boolean

Whether the intercept URL patterns should be prepended with context path if defined. Defaults to true.

Set whether to enable bearer token authentication. Default value true.

micronaut.security.authentication-provider-strategy

AuthenticationStrategy

Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL.

micronaut.security.token.bearer.prefix

java.lang.String

Sets the prefix to use for the auth token. Default value Bearer.

micronaut.security.reject-not-found

boolean

Whether the server should respond with 401 for requests that do not match any routes on the server, if you set it to false, it will return 404 for requests that do not match any routes on the server. Default value (true).

micronaut.security.token.bearer.header-name

java.lang.String

Sets the header name to use. Default value Authorization.
-🔗 +🔗 - +@@ -685,21 +709,31 @@

Micronaut Security Config Propert

- + + + + + + + + + + + - + - + - +
Table 17. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationPropertiesTable 18. Configuration Properties for LogoutControllerConfigurationProperties

micronaut.security.redirect.unauthorized.url

micronaut.security.endpoints.logout.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.logout.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.logout.path

java.lang.String

Where the user is redirected to after trying to access a secured route. Default value ("/").

Path to the LogoutController. Default value "/logout".

micronaut.security.redirect.unauthorized.enabled

micronaut.security.endpoints.logout.get-allowed

boolean

Whether it should redirect on unauthorized rejections. Default value (true).
-🔗 +🔗 - +@@ -714,16 +748,24 @@

Micronaut Security Config Propert

- - - + + + + + + + +
Table 18. Configuration Properties for AccessTokenConfigurationPropertiesTable 19. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationProperties

micronaut.security.token.generator.access-token.expiration

java.lang.Integer

Access token expiration. Default value (3600).

micronaut.security.redirect.forbidden.url

java.lang.String

Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/").

micronaut.security.redirect.forbidden.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).
-🔗 +

+
+

Micronaut Security Csrf Config Properties

+🔗 - +@@ -738,34 +780,31 @@

Micronaut Security Config Propert

- + - + - - - + + + - - - + + + - - - + + +
Table 19. Configuration Properties for LogoutControllerConfigurationPropertiesTable 20. Configuration Properties for CsrfFilterConfigurationProperties

micronaut.security.endpoints.logout.post-content-types

micronaut.security.csrf.filter.methods

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

Filter will only process requests whose method matches any of these methods. Default Value is POST, PUT, DELETE, PATCH.

micronaut.security.endpoints.logout.enabled

boolean

Whether the controller is enabled.

micronaut.security.csrf.filter.content-types

java.util.Set

Filter will only process requests whose content type matches any of these content types. Default Value is application/x-www-form-urlencoded, multipart/form-data.

micronaut.security.endpoints.logout.path

java.lang.String

Path to the LogoutController. Default value "/logout".

micronaut.security.csrf.filter.enabled

boolean

Whether the filter is enabled. Default value true.

micronaut.security.endpoints.logout.get-allowed

boolean

micronaut.security.csrf.filter.regex-pattern

java.lang.String

CSRF filter processes only request paths matching this regular expression. Default Value: "^.*$"
-
-
-

Micronaut Security Csrf Config Properties

🔗 - +@@ -847,9 +886,12 @@

Micronaut Security Csrf Conf

Table 20. Configuration Properties for CsrfConfigurationPropertiesTable 21. Configuration Properties for CsrfConfigurationProperties
-🔗 +
+
+

Micronaut Security Jwt Config Properties

+🔗 - +@@ -864,58 +906,46 @@

Micronaut Security Csrf Conf

- - - + + + - - - + + + - + - + - - - + + + - -
Table 21. Configuration Properties for CsrfFilterConfigurationPropertiesTable 22. Configuration Properties for JwtClaimsValidatorConfigurationProperties

micronaut.security.csrf.filter.methods

java.util.Set

Filter will only process requests whose method matches any of these methods. Default Value is POST, PUT, DELETE, PATCH.

micronaut.security.token.jwt.claims-validators.issuer

java.lang.String

Whether the iss claim should be validated to ensure it matches this value. It defaults to null, thus it is not validated.

micronaut.security.csrf.filter.content-types

java.util.Set

Filter will only process requests whose content type matches any of these content types. Default Value is application/x-www-form-urlencoded, multipart/form-data.

micronaut.security.token.jwt.claims-validators.audience

java.lang.String

Whether the aud claim should be validated to ensure it matches this value. It defaults to null, thus it is not validated.

micronaut.security.csrf.filter.enabled

micronaut.security.token.jwt.claims-validators.subject-not-null

boolean

Whether the filter is enabled. Default value true.

Whether the JWT subject claim should be validated to ensure it is not null. Default value true.

micronaut.security.csrf.filter.regex-pattern

java.lang.String

CSRF filter processes only request paths matching this regular expression. Default Value: "^.*$"

micronaut.security.token.jwt.claims-validators.not-before

boolean
-
-
-
-

Micronaut Security Jwt Config Properties

-🔗 - - ----- - - - - + + + + + + + + - - - + - +
Table 22. Configuration Properties for JwtConfigurationProperties
PropertyTypeDescription

micronaut.security.token.jwt.claims-validators.expiration

boolean

Whether the expiration date of the JWT should be validated. Default value true.

micronaut.security.token.jwt.claims-validators.nonce

boolean

Whether the nonce claim should be validated when a nonce was present. Default value true.

micronaut.security.token.jwt.enabled

micronaut.security.token.jwt.claims-validators.openid-idtoken

boolean

Sets whether JWT security is enabled. Default value (true).

Whether IdTokenClaimsValidator, which performs some fo the verifications described in OpenID Connect Spec, is enabled. Default value true. Only applies for idtoken authentication mode.
-🔗 +🔗 - +@@ -930,26 +960,26 @@

Micronaut Security Jwt Config

- - + + - - + + - - + +
Table 23. Configuration Properties for SecretEncryptionConfigurationTable 23. Configuration Properties for JwksSignatureConfigurationProperties

micronaut.security.token.jwt.encryptions.secret.*.secret

java.lang.String

micronaut.security.token.jwt.signatures.jwks.*.cache-expiration

java.lang.Integer

micronaut.security.token.jwt.encryptions.secret.*.jwe-algorithm

com.nimbusds.jose.JWEAlgorithm

micronaut.security.token.jwt.signatures.jwks.*.url

java.lang.String

micronaut.security.token.jwt.encryptions.secret.*.encryption-method

com.nimbusds.jose.EncryptionMethod

micronaut.security.token.jwt.signatures.jwks.*.key-type

com.nimbusds.jose.jwk.KeyType
-🔗 +🔗 - +@@ -964,26 +994,16 @@

Micronaut Security Jwt Config

- - - - - - - - - - - + - +
Table 24. Configuration Properties for SecretSignatureConfigurationTable 24. Configuration Properties for JwtConfigurationProperties

micronaut.security.token.jwt.signatures.secret.*.jws-algorithm

com.nimbusds.jose.JWSAlgorithm

micronaut.security.token.jwt.signatures.secret.*.secret

java.lang.String

micronaut.security.token.jwt.signatures.secret.*.base64

micronaut.security.token.jwt.enabled

boolean

Sets whether JWT security is enabled. Default value (true).
-🔗 +🔗 - +@@ -998,24 +1018,19 @@

Micronaut Security Jwt Config

- - - - - - + - + - + - + - + - +
Table 25. Configuration Properties for RefreshTokenConfigurationPropertiesTable 25. Configuration Properties for SecretSignatureConfiguration

micronaut.security.token.jwt.generator.refresh-token.enabled

boolean

Sets whether SignedRefreshTokenGenerator is enabled. Default value (true).

micronaut.security.token.jwt.generator.refresh-token.jws-algorithm

micronaut.security.token.jwt.signatures.secret.*.jws-algorithm

com.nimbusds.jose.JWSAlgorithm

{@link com.nimbusds.jose.JWSAlgorithm}. Defaults to HS256

micronaut.security.token.jwt.generator.refresh-token.secret

micronaut.security.token.jwt.signatures.secret.*.secret

java.lang.String

shared secret. For HS256 must be at least 256 bits.

micronaut.security.token.jwt.generator.refresh-token.base64

micronaut.security.token.jwt.signatures.secret.*.base64

boolean

Indicates whether the supplied secret is base64 encoded. Default value false.
@@ -1044,9 +1059,9 @@

Micronaut Security Jwt Config
-🔗 +🔗 - +@@ -1061,26 +1076,26 @@

Micronaut Security Jwt Config

- - - + + + - - - + + + - - - + + +
Table 27. Configuration Properties for JwksSignatureConfigurationPropertiesTable 27. Configuration Properties for NimbusJsonWebTokenValidatorConfigurationProperties

micronaut.security.token.jwt.signatures.jwks.*.cache-expiration

java.lang.Integer

micronaut.security.token.jwt.nimbus.reactive-validator

boolean

Whether the bean {@link NimbusReactiveJsonWebTokenValidator} is enabled. Default value true.

micronaut.security.token.jwt.signatures.jwks.*.url

java.lang.String

micronaut.security.token.jwt.nimbus.validator

boolean

Whether the bean {@link NimbusJsonWebTokenValidator} is enabled. Default value true.

micronaut.security.token.jwt.signatures.jwks.*.key-type

com.nimbusds.jose.jwk.KeyType

micronaut.security.token.jwt.nimbus.reactive-validator-execute-on-blocking

boolean

Whether {@link NimbusReactiveJsonWebTokenValidator} should subscribe on a scheduler created with the blocking task executor. Default value false.
-🔗 +🔗 - +@@ -1095,46 +1110,26 @@

Micronaut Security Jwt Config

- - - - - - + - - - - - - - - - - - - - - - - - - + + + - - - + + +
Table 28. Configuration Properties for JwtClaimsValidatorConfigurationPropertiesTable 28. Configuration Properties for SecretEncryptionConfiguration

micronaut.security.token.jwt.claims-validators.issuer

java.lang.String

Whether the iss claim should be validated to ensure it matches this value. It defaults to null, thus it is not validated.

micronaut.security.token.jwt.claims-validators.audience

micronaut.security.token.jwt.encryptions.secret.*.secret

java.lang.String

Whether the aud claim should be validated to ensure it matches this value. It defaults to null, thus it is not validated.

micronaut.security.token.jwt.claims-validators.subject-not-null

boolean

Whether the JWT subject claim should be validated to ensure it is not null. Default value true.

micronaut.security.token.jwt.claims-validators.not-before

boolean

micronaut.security.token.jwt.claims-validators.expiration

boolean

Whether the expiration date of the JWT should be validated. Default value true.

micronaut.security.token.jwt.claims-validators.nonce

boolean

Whether the nonce claim should be validated when a nonce was present. Default value true.

micronaut.security.token.jwt.encryptions.secret.*.jwe-algorithm

com.nimbusds.jose.JWEAlgorithm

micronaut.security.token.jwt.claims-validators.openid-idtoken

boolean

Whether IdTokenClaimsValidator, which performs some fo the verifications described in OpenID Connect Spec, is enabled. Default value true. Only applies for idtoken authentication mode.

micronaut.security.token.jwt.encryptions.secret.*.encryption-method

com.nimbusds.jose.EncryptionMethod
-🔗 +🔗 - +@@ -1149,19 +1144,24 @@

Micronaut Security Jwt Config

- + - + - - - + + + - + + + + + + - +
Table 29. Configuration Properties for NimbusJsonWebTokenValidatorConfigurationPropertiesTable 29. Configuration Properties for RefreshTokenConfigurationProperties

micronaut.security.token.jwt.nimbus.reactive-validator

micronaut.security.token.jwt.generator.refresh-token.enabled

boolean

Whether the bean {@link NimbusReactiveJsonWebTokenValidator} is enabled. Default value true.

Sets whether SignedRefreshTokenGenerator is enabled. Default value (true).

micronaut.security.token.jwt.nimbus.validator

boolean

Whether the bean {@link NimbusJsonWebTokenValidator} is enabled. Default value true.

micronaut.security.token.jwt.generator.refresh-token.jws-algorithm

com.nimbusds.jose.JWSAlgorithm

{@link com.nimbusds.jose.JWSAlgorithm}. Defaults to HS256

micronaut.security.token.jwt.nimbus.reactive-validator-execute-on-blocking

micronaut.security.token.jwt.generator.refresh-token.secret

java.lang.String

shared secret. For HS256 must be at least 256 bits.

micronaut.security.token.jwt.generator.refresh-token.base64

boolean

Whether {@link NimbusReactiveJsonWebTokenValidator} should subscribe on a scheduler created with the blocking task executor. Default value false.

Indicates whether the supplied secret is base64 encoded. Default value false.
@@ -1222,9 +1222,9 @@

Micronaut Security Ldap Conf
-🔗 +🔗 - +@@ -1239,31 +1239,41 @@

Micronaut Security Ldap Conf

- + - + - + - + + + + + + + + + + +
Table 32. Configuration Properties for LdapConfiguration$SearchConfigurationTable 32. Configuration Properties for LdapConfiguration$GroupConfiguration

micronaut.security.ldap.*.search.subtree

micronaut.security.ldap.*.groups.subtree

boolean

micronaut.security.ldap.*.search.base

micronaut.security.ldap.*.groups.base

java.lang.String

micronaut.security.ldap.*.search.filter

micronaut.security.ldap.*.groups.filter

java.lang.String

micronaut.security.ldap.*.search.attributes

micronaut.security.ldap.*.groups.attribute

java.lang.String

micronaut.security.ldap.*.groups.enabled

boolean

Sets if group search is enabled. Default false

micronaut.security.ldap.*.groups.filter-attribute

java.lang.String

The argument to pass to the search filter.
-🔗 +🔗 - +@@ -1278,41 +1288,78 @@

Micronaut Security Ldap Conf

- - + + - + - + - + - + + + + + +
Table 33. Configuration Properties for LdapConfiguration$GroupConfigurationTable 33. Configuration Properties for LdapConfiguration$ContextConfiguration

micronaut.security.ldap.*.groups.subtree

boolean

micronaut.security.ldap.*.context.server

java.lang.String

micronaut.security.ldap.*.groups.base

micronaut.security.ldap.*.context.manager-dn

java.lang.String

micronaut.security.ldap.*.groups.filter

micronaut.security.ldap.*.context.manager-password

java.lang.String

micronaut.security.ldap.*.groups.attribute

micronaut.security.ldap.*.context.factory

java.lang.String

micronaut.security.ldap.*.groups.enabled

micronaut.security.ldap.*.context.properties

java.util.Map

+
+🔗 + + +++++ + + + + + + + + + + - + - + - + + + + + + + + + + +
Table 34. Configuration Properties for LdapConfiguration$SearchConfiguration
PropertyTypeDescription

micronaut.security.ldap.*.search.subtree

boolean

Sets if group search is enabled. Default false

micronaut.security.ldap.*.groups.filter-attribute

micronaut.security.ldap.*.search.base

java.lang.String

The argument to pass to the search filter.

micronaut.security.ldap.*.search.filter

java.lang.String

micronaut.security.ldap.*.search.attributes

java.lang.String
-🔗 +

+
+

Micronaut Security Oauth2 Config Properties

+🔗 - +@@ -1327,39 +1374,86 @@

Micronaut Security Ldap Conf

- + - + - + + + + + + + + + + + + + + + + + + + + +
Table 34. Configuration Properties for LdapConfiguration$ContextConfigurationTable 35. Configuration Properties for OauthClientConfigurationProperties

micronaut.security.ldap.*.context.server

micronaut.security.oauth2.clients.*.client-id

java.lang.String

OAuth 2.0 client id.

micronaut.security.ldap.*.context.manager-dn

micronaut.security.oauth2.clients.*.client-secret

java.lang.String

OAuth 2.0 client secret.

micronaut.security.oauth2.clients.*.enabled

boolean

Sets whether the client is enabled. Default value (true).

micronaut.security.oauth2.clients.*.scopes

java.util.List

Requested scopes. If not specified for OAuth 2.0 clients using OpenID Connect it defaults to profile, email and idtoken

micronaut.security.oauth2.clients.*.grant-type

GrantType

OAuth 2.0 grant type. Default value (authorization_code).

+
+🔗 + + +++++ + + + + + + + + + + - + - + + + + + + - + - + + + + + +
Table 36. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties
PropertyTypeDescription

micronaut.security.oauth2.clients.*.client-credentials.service-id-regex

java.lang.String

micronaut.security.ldap.*.context.manager-password

micronaut.security.oauth2.clients.*.client-credentials.uri-regex

java.lang.String

micronaut.security.ldap.*.context.factory

micronaut.security.oauth2.clients.*.client-credentials.advanced-expiration

java.time.Duration

Number of seconds for a token obtained via client credentials grant to be considered expired + prior to its expiration date. Default value (30 seconds).

micronaut.security.oauth2.clients.*.client-credentials.scope

java.lang.String

Scope to be requested in the client credentials request. Defaults to none.

micronaut.security.ldap.*.context.properties

micronaut.security.oauth2.clients.*.client-credentials.enabled

boolean

Enables ClientCredentialsClient. Default value true

micronaut.security.oauth2.clients.*.client-credentials.additional-request-params

java.util.Map
-
-
-

Micronaut Security Oauth2 Config Properties

-🔗 +🔗 - +@@ -1374,31 +1468,22 @@

Micronaut Security Oauth2

- - - - - - - - - - - + - + - - - + + +
Table 35. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$TokenEndpointConfigurationPropertiesTable 37. Configuration Properties for DefaultStateConfiguration

micronaut.security.oauth2.clients.*.openid.token.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.openid.token.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.openid.token.authentication-method

micronaut.security.oauth2.state.persistence

java.lang.String

Authentication Method

Sets the mechanism to persist the state for later retrieval for validation. + Supported values ("session", "cookie"). Default value ("cookie").

micronaut.security.oauth2.clients.*.openid.token.content-type

MediaType

The content type of token endpoint requests. Default value (application/x-www-form-urlencoded).

micronaut.security.oauth2.state.enabled

boolean

Sets whether a state parameter will be sent. Default (true).
-🔗 +🔗 - +@@ -1413,16 +1498,22 @@

Micronaut Security Oauth2

- + - + + + + + +
Table 36. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationPropertiesTable 38. Configuration Properties for DefaultNonceConfiguration

micronaut.security.oauth2.openid.logout-uri

micronaut.security.oauth2.openid.nonce.persistence

java.lang.String

The URI used to log out of an OpenID provider. Default value ("/oauth/logout").

Sets the mechanism to persist the nonce for later retrieval for validation. + Supported values ("session", "cookie"). Default value ("cookie").

micronaut.security.oauth2.openid.nonce.enabled

boolean

Sets whether a nonce parameter will be sent. Default (true).
-🔗 +🔗 - +@@ -1437,21 +1528,27 @@

Micronaut Security Oauth2

- + + + + + + - + - + - +
Table 37. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$EndSessionConfigurationPropertiesTable 39. Configuration Properties for PkceConfigurationProperties

micronaut.security.oauth2.clients.*.openid.end-session.url

micronaut.security.oauth2.pkce.entropy

int

entropy (in bytes) used for the code verifier generation. Default value 64.

micronaut.security.oauth2.pkce.persistence

java.lang.String

The endpoint URL

Sets the mechanism to persist the state for later retrieval for validation. + Supported values ("session", "cookie"). Default value (PERSISTENCE_COOKIE).

micronaut.security.oauth2.clients.*.openid.end-session.enabled

micronaut.security.oauth2.pkce.enabled

boolean

The end session enabled flag. Default value (true).

Sets whether a state parameter will be sent. Default (true).
-🔗 +🔗 - +@@ -1466,26 +1563,26 @@

Micronaut Security Oauth2

- - - + + + - - + + - + - +
Table 38. Configuration Properties for OauthClientConfigurationProperties$IntrospectionEndpointConfigurationPropertiesTable 40. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties$HeaderTokenPropagatorConfigurationProperties

micronaut.security.oauth2.clients.*.introspection.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.client-credentials.header-propagation.enabled

boolean

Enable {@link ClientCredentialsHeaderTokenPropagatorConfiguration}. Default value (true).

micronaut.security.oauth2.clients.*.introspection.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.client-credentials.header-propagation.prefix

java.lang.String

micronaut.security.oauth2.clients.*.introspection.authentication-method

micronaut.security.oauth2.clients.*.client-credentials.header-propagation.header-name

java.lang.String

Authentication Method
-🔗 +🔗 - +@@ -1500,16 +1597,16 @@

Micronaut Security Oauth2

- +
Table 39. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$UserInfoEndpointConfigurationPropertiesTable 41. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$RegistrationEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.openid.user-info.url

micronaut.security.oauth2.clients.*.openid.registration.url

java.lang.String

The endpoint URL
-🔗 +🔗 - +@@ -1524,33 +1621,16 @@

Micronaut Security Oauth2

- - - - - - - - - - - - - - - - + - +
Table 40. Configuration Properties for OauthConfigurationPropertiesTable 42. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$EndSessionConfigurationProperties

micronaut.security.oauth2.enabled

boolean

Sets whether the OAuth 2.0 support is enabled. Default value (true).

micronaut.security.oauth2.login-uri

java.lang.String

The URI template that is used to initiate an OAuth 2.0 - authorization code grant flow. Default value ("/oauth/login{/provider}").

micronaut.security.oauth2.callback-uri

java.lang.String

The URI template that OAuth 2.0 providers can use to - submit an authorization callback request. Default value ("/oauth/callback{/provider}").

micronaut.security.oauth2.default-provider

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

java.lang.String

The default authentication provider for an OAuth 2.0 authorization code grant flow.

The URI the OpenID provider should redirect to after logging out. Default value ("/logout").
-🔗 +🔗 - +@@ -1565,22 +1645,29 @@

Micronaut Security Oauth2

- - - + + + - + - + + + + + +
Table 41. Configuration Properties for DefaultNonceConfigurationTable 43. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$ClaimsValidationConfigurationProperties

micronaut.security.oauth2.openid.nonce.persistence

java.lang.String

Sets the mechanism to persist the nonce for later retrieval for validation. - Supported values ("session", "cookie"). Default value ("cookie").

micronaut.security.oauth2.openid.claims-validation.issuer

boolean

Whether IssuerClaimValidator + is enabled. Default value (true).

micronaut.security.oauth2.openid.nonce.enabled

micronaut.security.oauth2.openid.claims-validation.audience

boolean

Sets whether a nonce parameter will be sent. Default (true).

Whether AudienceClaimValidator + is enabled. Default value (true).

micronaut.security.oauth2.openid.claims-validation.authorized-party

boolean

Whether AuthorizedPartyClaimValidator + is enabled. Default value (true).
-🔗 +🔗 - +@@ -1595,57 +1682,16 @@

Micronaut Security Oauth2

- + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 42. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$AuthorizationEndpointConfigurationPropertiesTable 44. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$UserInfoEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.openid.authorization.url

micronaut.security.oauth2.clients.*.openid.user-info.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.openid.authorization.response-type

ResponseType

Determines the authorization processing flow to be used. Default value (code).

micronaut.security.oauth2.clients.*.openid.authorization.response-mode

java.lang.String

Mechanism to be used for returning authorization response parameters from the - authorization endpoint.

micronaut.security.oauth2.clients.*.openid.authorization.display

Display

Controls how the authentication interface is displayed.

micronaut.security.oauth2.clients.*.openid.authorization.prompt

Prompt

Controls how the authentication server prompts the user.

micronaut.security.oauth2.clients.*.openid.authorization.max-age

java.lang.Integer

Maximum authentication age.

micronaut.security.oauth2.clients.*.openid.authorization.ui-locales

java.util.List

Preferred locales for authentication.

micronaut.security.oauth2.clients.*.openid.authorization.acr-values

java.util.List

Authentication class reference values.

micronaut.security.oauth2.clients.*.openid.authorization.code-challenge-method

java.lang.String

Code Challenge Method to use for PKCE.
-🔗 +🔗 - +@@ -1660,26 +1706,21 @@

Micronaut Security Oauth2

- + - - - - - - + - +
Table 43. Configuration Properties for OauthClientConfigurationProperties$RevocationEndpointConfigurationPropertiesTable 45. Configuration Properties for OauthClientConfigurationProperties$AuthorizationEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.revocation.url

micronaut.security.oauth2.clients.*.authorization.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.revocation.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.revocation.authentication-method

micronaut.security.oauth2.clients.*.authorization.code-challenge-method

java.lang.String

Authentication Method

Code Challenge Method to use for PKCE.
-🔗 +🔗 - +@@ -1694,29 +1735,29 @@

Micronaut Security Oauth2

- + - + - + - + - + - +
Table 44. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$ClaimsValidationConfigurationPropertiesTable 46. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$AdditionalClaimsConfigurationProperties

micronaut.security.oauth2.openid.claims-validation.issuer

micronaut.security.oauth2.openid.additional-claims.jwt

boolean

Whether IssuerClaimValidator - is enabled. Default value (true).

Set to true if the original JWT from the provider should be included in the Micronaut JWT. + Default value (false).

micronaut.security.oauth2.openid.claims-validation.audience

micronaut.security.oauth2.openid.additional-claims.access-token

boolean

Whether AudienceClaimValidator - is enabled. Default value (true).

Set to true if the original access token from the provider should be included in the Micronaut JWT. + Default value (false).

micronaut.security.oauth2.openid.claims-validation.authorized-party

micronaut.security.oauth2.openid.additional-claims.refresh-token

boolean

Whether AuthorizedPartyClaimValidator - is enabled. Default value (true).

Set to true if the original refresh token from the provider should be included in the Micronaut JWT. + Default value (false).
-🔗 +🔗 - +@@ -1731,41 +1772,41 @@

Micronaut Security Oauth2

- + - + - + - + - + - + - +
Table 45. Configuration Properties for CookiePkcePersistenceConfigurationTable 47. Configuration Properties for CookieNoncePersistenceConfiguration

micronaut.security.oauth2.pkce.cookie.cookie-domain

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

java.lang.String

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

micronaut.security.oauth2.pkce.cookie.cookie-secure

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

java.lang.Boolean

Sets whether the cookie is secured. Defaults to the secure status of the request.

micronaut.security.oauth2.pkce.cookie.cookie-name

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

java.lang.String

Cookie Name. Default value {@link #DEFAULT_COOKIE_NAME}.

Cookie Name. Default value {@link #DEFAULT_COOKIENAME}.

micronaut.security.oauth2.pkce.cookie.cookie-path

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

java.lang.String

Sets the path of the cookie. Default value ("/").

micronaut.security.oauth2.pkce.cookie.cookie-http-only

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

java.lang.Boolean

Whether the Cookie can only be accessed via HTTP. Default value (true).

micronaut.security.oauth2.pkce.cookie.cookie-max-age

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

java.time.Duration

Sets the maximum age of the cookie. Default value (5 minutes).
-🔗 +🔗 - +@@ -1780,29 +1821,27 @@

Micronaut Security Oauth2

- - - - - - - - + + + - - - + + + + + + + +
Table 46. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$AdditionalClaimsConfigurationPropertiesTable 48. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties

micronaut.security.oauth2.openid.additional-claims.jwt

boolean

Set to true if the original JWT from the provider should be included in the Micronaut JWT. - Default value (false).

micronaut.security.oauth2.openid.additional-claims.access-token

boolean

Set to true if the original access token from the provider should be included in the Micronaut JWT. - Default value (false).

micronaut.security.oauth2.clients.*.openid.issuer

java.net.URL

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.additional-claims.refresh-token

boolean

Set to true if the original refresh token from the provider should be included in the Micronaut JWT. - Default value (false).

micronaut.security.oauth2.clients.*.openid.configuration-path

java.lang.String

The configuration path to discover openid configuration. Default ("/.well-known/openid-configuration").

micronaut.security.oauth2.clients.*.openid.jwks-uri

java.lang.String

The JWKS signature URI.
-🔗 +🔗 - +@@ -1817,16 +1856,31 @@

Micronaut Security Oauth2

- + - + + + + + + + + + + + + + + + +
Table 47. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$EndSessionConfigurationPropertiesTable 49. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$TokenEndpointConfigurationProperties

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

micronaut.security.oauth2.clients.*.openid.token.url

java.lang.String

The URI the OpenID provider should redirect to after logging out. Default value ("/logout").

The endpoint URL

micronaut.security.oauth2.clients.*.openid.token.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.openid.token.authentication-method

java.lang.String

Authentication Method

micronaut.security.oauth2.clients.*.openid.token.content-type

MediaType

The content type of token endpoint requests. Default value (application/x-www-form-urlencoded).
🔗 - +@@ -1873,9 +1927,9 @@

Micronaut Security Oauth2

Table 48. Configuration Properties for CookieStatePersistenceConfigurationTable 50. Configuration Properties for CookieStatePersistenceConfiguration
-🔗 +🔗 - +@@ -1890,27 +1944,26 @@

Micronaut Security Oauth2

- - - + + + - - - + + + - + - +
Table 49. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationPropertiesTable 51. Configuration Properties for OauthClientConfigurationProperties$IntrospectionEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.openid.issuer

java.net.URL

URL using the https scheme with no query or fragment component that the - Open ID provider asserts as its issuer identifier.

micronaut.security.oauth2.clients.*.introspection.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.openid.configuration-path

java.lang.String

The configuration path to discover openid configuration. Default ("/.well-known/openid-configuration").

micronaut.security.oauth2.clients.*.introspection.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.openid.jwks-uri

micronaut.security.oauth2.clients.*.introspection.authentication-method

java.lang.String

The JWKS signature URI.

Authentication Method
-🔗 +🔗 - +@@ -1925,41 +1978,16 @@

Micronaut Security Oauth2

- - - - - - - - - - - - - - - - + - - - - - - - - - - - +
Table 50. Configuration Properties for CookieNoncePersistenceConfigurationTable 52. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties

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

java.lang.String

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

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

java.lang.Boolean

Sets whether the cookie is secured. Defaults to the secure status of the request.

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

java.lang.String

Cookie Name. Default value {@link #DEFAULT_COOKIENAME}.

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

micronaut.security.oauth2.openid.logout-uri

java.lang.String

Sets the path of the cookie. Default value ("/").

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

java.lang.Boolean

Whether the Cookie can only be accessed via HTTP. Default value (true).

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

java.time.Duration

Sets the maximum age of the cookie. Default value (5 minutes).

The URI used to log out of an OpenID provider. Default value ("/oauth/logout").
-🔗 +🔗 - +@@ -1974,21 +2002,21 @@

Micronaut Security Oauth2

- + - - - + + +
Table 51. Configuration Properties for OauthClientConfigurationProperties$AuthorizationEndpointConfigurationPropertiesTable 53. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$EndSessionConfigurationProperties

micronaut.security.oauth2.clients.*.authorization.url

micronaut.security.oauth2.clients.*.openid.end-session.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.authorization.code-challenge-method

java.lang.String

Code Challenge Method to use for PKCE.

micronaut.security.oauth2.clients.*.openid.end-session.enabled

boolean

The end session enabled flag. Default value (true).
-🔗 +🔗 - +@@ -2003,66 +2031,57 @@

Micronaut Security Oauth2

- + - -
Table 52. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$RegistrationEndpointConfigurationPropertiesTable 54. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$AuthorizationEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.openid.registration.url

micronaut.security.oauth2.clients.*.openid.authorization.url

java.lang.String

The endpoint URL
-
-🔗 - - ----- - - - - + + + - - - + - + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + + + + + +
Table 53. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties
PropertyTypeDescription

micronaut.security.oauth2.clients.*.openid.authorization.response-type

ResponseType

Determines the authorization processing flow to be used. Default value (code).

micronaut.security.oauth2.clients.*.client-credentials.service-id-regex

micronaut.security.oauth2.clients.*.openid.authorization.response-mode

java.lang.String

Mechanism to be used for returning authorization response parameters from the + authorization endpoint.

micronaut.security.oauth2.clients.*.client-credentials.uri-regex

java.lang.String

micronaut.security.oauth2.clients.*.openid.authorization.display

Display

Controls how the authentication interface is displayed.

micronaut.security.oauth2.clients.*.client-credentials.advanced-expiration

java.time.Duration

Number of seconds for a token obtained via client credentials grant to be considered expired - prior to its expiration date. Default value (30 seconds).

micronaut.security.oauth2.clients.*.openid.authorization.prompt

Prompt

Controls how the authentication server prompts the user.

micronaut.security.oauth2.clients.*.client-credentials.scope

java.lang.String

Scope to be requested in the client credentials request. Defaults to none.

micronaut.security.oauth2.clients.*.openid.authorization.max-age

java.lang.Integer

Maximum authentication age.

micronaut.security.oauth2.clients.*.client-credentials.enabled

boolean

Enables ClientCredentialsClient. Default value true

micronaut.security.oauth2.clients.*.openid.authorization.ui-locales

java.util.List

Preferred locales for authentication.

micronaut.security.oauth2.clients.*.client-credentials.additional-request-params

java.util.Map

micronaut.security.oauth2.clients.*.openid.authorization.acr-values

java.util.List

Authentication class reference values.

micronaut.security.oauth2.clients.*.openid.authorization.code-challenge-method

java.lang.String

Code Challenge Method to use for PKCE.
-🔗 +🔗 - +@@ -2077,26 +2096,26 @@

Micronaut Security Oauth2

- + - + - +
Table 54. Configuration Properties for OauthClientConfigurationProperties$TokenEndpointConfigurationPropertiesTable 55. Configuration Properties for OauthClientConfigurationProperties$RevocationEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.token.url

micronaut.security.oauth2.clients.*.revocation.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.token.auth-method

micronaut.security.oauth2.clients.*.revocation.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.token.authentication-method

micronaut.security.oauth2.clients.*.revocation.authentication-method

java.lang.String

Authentication Method
-🔗 +🔗 - +@@ -2111,36 +2130,41 @@

Micronaut Security Oauth2

- + - + - + + + + + + - + - - - + + + - - - + + + - - - + + +
Table 55. Configuration Properties for OauthClientConfigurationPropertiesTable 56. Configuration Properties for CookiePkcePersistenceConfiguration

micronaut.security.oauth2.clients.*.client-id

micronaut.security.oauth2.pkce.cookie.cookie-domain

java.lang.String

OAuth 2.0 client id.

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

micronaut.security.oauth2.clients.*.client-secret

micronaut.security.oauth2.pkce.cookie.cookie-secure

java.lang.Boolean

Sets whether the cookie is secured. Defaults to the secure status of the request.

micronaut.security.oauth2.pkce.cookie.cookie-name

java.lang.String

OAuth 2.0 client secret.

Cookie Name. Default value {@link #DEFAULT_COOKIE_NAME}.

micronaut.security.oauth2.clients.*.enabled

boolean

Sets whether the client is enabled. Default value (true).

micronaut.security.oauth2.pkce.cookie.cookie-path

java.lang.String

Sets the path of the cookie. Default value ("/").

micronaut.security.oauth2.clients.*.scopes

java.util.List

Requested scopes. If not specified for OAuth 2.0 clients using OpenID Connect it defaults to profile, email and idtoken

micronaut.security.oauth2.pkce.cookie.cookie-http-only

java.lang.Boolean

Whether the Cookie can only be accessed via HTTP. Default value (true).

micronaut.security.oauth2.clients.*.grant-type

GrantType

OAuth 2.0 grant type. Default value (authorization_code).

micronaut.security.oauth2.pkce.cookie.cookie-max-age

java.time.Duration

Sets the maximum age of the cookie. Default value (5 minutes).
-🔗 +🔗 - +@@ -2155,26 +2179,26 @@

Micronaut Security Oauth2

- - - + + + - - + + - + - +
Table 56. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties$HeaderTokenPropagatorConfigurationPropertiesTable 57. Configuration Properties for OauthClientConfigurationProperties$TokenEndpointConfigurationProperties

micronaut.security.oauth2.clients.*.client-credentials.header-propagation.enabled

boolean

Enable {@link ClientCredentialsHeaderTokenPropagatorConfiguration}. Default value (true).

micronaut.security.oauth2.clients.*.token.url

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.client-credentials.header-propagation.prefix

java.lang.String

micronaut.security.oauth2.clients.*.token.auth-method

AuthenticationMethod

micronaut.security.oauth2.clients.*.client-credentials.header-propagation.header-name

micronaut.security.oauth2.clients.*.token.authentication-method

java.lang.String

Authentication Method
-🔗 +🔗 - +@@ -2189,50 +2213,26 @@

Micronaut Security Oauth2

- - - - - - - - - - - + - + - -
Table 57. Configuration Properties for PkceConfigurationPropertiesTable 58. Configuration Properties for OauthConfigurationProperties

micronaut.security.oauth2.pkce.entropy

int

entropy (in bytes) used for the code verifier generation. Default value 64.

micronaut.security.oauth2.pkce.persistence

java.lang.String

Sets the mechanism to persist the state for later retrieval for validation. - Supported values ("session", "cookie"). Default value (PERSISTENCE_COOKIE).

micronaut.security.oauth2.pkce.enabled

micronaut.security.oauth2.enabled

boolean

Sets whether a state parameter will be sent. Default (true).

Sets whether the OAuth 2.0 support is enabled. Default value (true).
-
-🔗 - - ----- - - - - + + + - - - + - + - - - + + +
Table 58. Configuration Properties for DefaultStateConfiguration
PropertyTypeDescription

micronaut.security.oauth2.login-uri

java.lang.String

The URI template that is used to initiate an OAuth 2.0 + authorization code grant flow. Default value ("/oauth/login{/provider}").

micronaut.security.oauth2.state.persistence

micronaut.security.oauth2.callback-uri

java.lang.String

Sets the mechanism to persist the state for later retrieval for validation. - Supported values ("session", "cookie"). Default value ("cookie").

The URI template that OAuth 2.0 providers can use to + submit an authorization callback request. Default value ("/oauth/callback{/provider}").

micronaut.security.oauth2.state.enabled

boolean

Sets whether a state parameter will be sent. Default (true).

micronaut.security.oauth2.default-provider

java.lang.String

The default authentication provider for an OAuth 2.0 authorization code grant flow.