From 1dd3f62a9ecad7a9c19ad5f2f57aed43c3d4466e Mon Sep 17 00:00:00 2001 From: sdelamo Date: Mon, 5 Feb 2024 13:21:52 +0000 Subject: [PATCH] Deploying to gh-pages - 13:21:52 --- snapshot/guide/configurationreference.html | 1328 ++++++++++---------- 1 file changed, 664 insertions(+), 664 deletions(-) diff --git a/snapshot/guide/configurationreference.html b/snapshot/guide/configurationreference.html index 3c30ff086e..ca4629e133 100644 --- a/snapshot/guide/configurationreference.html +++ b/snapshot/guide/configurationreference.html @@ -51,9 +51,9 @@

Configuration Reference

Micronaut Security Config Properties

-🔗 +🔗 - +@@ -68,76 +68,41 @@

Micronaut Security Config Propert

- - + + - + - - - -
Table 1. Configuration Properties for IntrospectionConfigurationPropertiesTable 1. Configuration Properties for TokenPropagationConfigurationProperties

micronaut.security.endpoints.introspection.enabled

boolean

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

java.lang.String

micronaut.security.endpoints.introspection.path

micronaut.security.token.propagation.uri-regex

java.lang.String

Path to the IntrospectionController. Default value "/token_info"

-
-🔗 - - ----- - - - - - - - - - - - - - - - - - + - - - + + + - - - + + + - + - - - - - - + - - - + + +
Table 2. Configuration Properties for SecurityConfigurationProperties
PropertyTypeDescription

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.token.propagation.service-id-pattern

java.util.regex.Pattern

micronaut.security.ip-patterns

java.util.List

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

micronaut.security.token.propagation.uri-pattern

java.util.regex.Pattern

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

micronaut.security.token.propagation.enabled

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.

Enables TokenPropagationHttpClientFilter. Default value false

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.propagation.path

java.lang.String
-🔗 +🔗 - +@@ -152,51 +117,38 @@

Micronaut Security Config Propert

- + - - - - - - - - - - - + - - - + + + - - - + + + - + - - - - - - + - - - + + +
Table 3. Configuration Properties for TokenCookieConfigurationPropertiesTable 2. 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

micronaut.security.token.cookie.cookie-name

java.lang.String

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

micronaut.security.redirect.enabled

boolean

Sets whether Redirection configuration enabled. Default value (true).
-🔗 +🔗 - +@@ -211,26 +163,21 @@

Micronaut Security Config Propert

- - - - - - + - + - + - +
Table 4. Configuration Properties for LogoutControllerConfigurationPropertiesTable 3. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationProperties

micronaut.security.endpoints.logout.enabled

boolean

micronaut.security.endpoints.logout.path

micronaut.security.redirect.refresh.url

java.lang.String

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

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

micronaut.security.endpoints.logout.get-allowed

micronaut.security.redirect.refresh.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).
-🔗 +🔗 - +@@ -245,21 +192,21 @@

Micronaut Security Config Propert

- + - + - - + +
Table 5. Configuration Properties for X509ConfigurationPropertiesTable 4. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationProperties

micronaut.security.x509.subject-dn-regex

micronaut.security.redirect.forbidden.url

java.lang.String

Set the Subject DN regex. Default value "CN=(.*?)(?:,

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

$)".

micronaut.security.x509.enabled

micronaut.security.redirect.forbidden.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).
-🔗 +🔗 - +@@ -274,21 +221,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 6. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationPropertiesTable 5. Configuration Properties for IntrospectionConfigurationProperties

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.endpoints.introspection.enabled

boolean

micronaut.security.redirect.refresh.enabled

boolean

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

micronaut.security.endpoints.introspection.path

java.lang.String

Path to the IntrospectionController. Default value "/token_info"
-🔗 +🔗 - +@@ -303,21 +250,16 @@

Micronaut Security Config Propert

- - - - - - + - +
Table 7. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationPropertiesTable 6. Configuration Properties for BasicAuthAuthenticationConfiguration

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

micronaut.security.basic-auth.enabled

boolean

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

Enables the {@link BasicAuthAuthenticationFetcher}. Default value true.
-🔗 +🔗 - +@@ -332,31 +274,26 @@

Micronaut Security Config Propert

- + - + - + - + - - - - -
Table 8. Configuration Properties for TokenConfigurationPropertiesTable 7. Configuration Properties for HttpHeaderTokenPropagatorConfigurationProperties

micronaut.security.token.enabled

micronaut.security.token.propagation.header.enabled

boolean

Sets whether the configuration is enabled. Default value true.

Enable HttpHeaderTokenPropagator. Default value (true).

micronaut.security.token.roles-name

micronaut.security.token.propagation.header.prefix

java.lang.String

micronaut.security.token.name-key

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

java.lang.String

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.
-🔗 +🔗 - +@@ -371,38 +308,26 @@

Micronaut Security Config Propert

- - - + + + - + - + - + - - - - - - - - - - - +
Table 9. Configuration Properties for RedirectConfigurationPropertiesTable 8. Configuration Properties for BearerTokenConfigurationProperties

micronaut.security.redirect.login-success

java.lang.String

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

micronaut.security.token.bearer.enabled

boolean

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

micronaut.security.redirect.login-failure

micronaut.security.token.bearer.prefix

java.lang.String

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

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

micronaut.security.redirect.logout

micronaut.security.token.bearer.header-name

java.lang.String

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

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.redirect.enabled

boolean

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

Sets the header name to use. Default value Authorization.
-🔗 +🔗 - +@@ -417,45 +342,51 @@

Micronaut Security Config Propert

- - - + + + - -
Table 10. Configuration Properties for AccessTokenConfigurationPropertiesTable 9. Configuration Properties for RefreshTokenCookieConfigurationProperties

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

java.lang.Integer

Access token expiration. Default value (3600).

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

java.lang.String
-
-🔗 - - ----- - - - - + + + - - - - - + + + - + + + + + + + + + + + - + + + + + + + + + + +
Table 11. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationProperties
PropertyTypeDescription

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

java.lang.Boolean

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.token.refresh.cookie.cookie-secure

java.lang.Boolean

micronaut.security.redirect.unauthorized.enabled

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

java.time.Duration

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

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

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

java.lang.String

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

java.lang.String
-🔗 +🔗 - +@@ -470,26 +401,51 @@

Micronaut Security Config Propert

- + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - +
Table 12. Configuration Properties for HttpHeaderTokenPropagatorConfigurationPropertiesTable 10. Configuration Properties for TokenCookieConfigurationProperties

micronaut.security.token.propagation.header.enabled

micronaut.security.token.cookie.cookie-domain

java.lang.String

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

java.lang.Boolean

micronaut.security.token.cookie.cookie-secure

java.lang.Boolean

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

java.time.Duration

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.cookie.enabled

boolean

Enable HttpHeaderTokenPropagator. Default value (true).

micronaut.security.token.propagation.header.prefix

micronaut.security.token.cookie.cookie-name

java.lang.String

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

micronaut.security.token.cookie.cookie-path

java.lang.String
-🔗 +🔗 - +@@ -504,16 +460,31 @@

Micronaut Security Config Propert

- + - + + + + + + + + + + + + + + + +
Table 13. Configuration Properties for BasicAuthAuthenticationConfigurationTable 11. Configuration Properties for TokenConfigurationProperties

micronaut.security.basic-auth.enabled

micronaut.security.token.enabled

boolean

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

Sets whether the configuration is enabled. Default value true.

micronaut.security.token.roles-name

java.lang.String

micronaut.security.token.name-key

java.lang.String

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.
-🔗 +🔗 - +@@ -528,26 +499,16 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - + + +
Table 14. Configuration Properties for BearerTokenConfigurationPropertiesTable 12. Configuration Properties for AccessTokenConfigurationProperties

micronaut.security.token.bearer.enabled

boolean

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

micronaut.security.token.bearer.prefix

java.lang.String

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

micronaut.security.token.bearer.header-name

java.lang.String

Sets the header name to use. Default value Authorization.

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

java.lang.Integer

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

Micronaut Security Config Propert

- - - - - - + - + - + + -
Table 15. Configuration Properties for OauthControllerConfigurationPropertiesTable 13. Configuration Properties for X509ConfigurationProperties

micronaut.security.endpoints.oauth.enabled

boolean

micronaut.security.endpoints.oauth.path

micronaut.security.x509.subject-dn-regex

java.lang.String

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

Set the Subject DN regex. Default value "CN=(.*?)(?:,

micronaut.security.endpoints.oauth.get-allowed

$)".

micronaut.security.x509.enabled

boolean
-🔗 +🔗 - +@@ -596,51 +552,26 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - + +
Table 16. Configuration Properties for RefreshTokenCookieConfigurationPropertiesTable 14. Configuration Properties for LogoutControllerConfigurationProperties

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

java.lang.String

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

java.lang.Boolean

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

java.lang.Boolean

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

java.time.Duration

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

micronaut.security.endpoints.logout.enabled

boolean

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

micronaut.security.endpoints.logout.path

java.lang.String

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

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

java.lang.String

micronaut.security.endpoints.logout.get-allowed

boolean
-🔗 +🔗 - +@@ -655,33 +586,18 @@

Micronaut Security Config Propert

- - + + - + - - - - - - - - - - - + - + - - - - - @@ -689,7 +605,7 @@

Micronaut Security Config Propert
🔗

Table 17. Configuration Properties for TokenPropagationConfigurationPropertiesTable 15. Configuration Properties for OauthControllerConfigurationProperties

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

java.lang.String

micronaut.security.endpoints.oauth.enabled

boolean

micronaut.security.token.propagation.uri-regex

micronaut.security.endpoints.oauth.path

java.lang.String

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

java.util.regex.Pattern

micronaut.security.token.propagation.uri-pattern

java.util.regex.Pattern

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

micronaut.security.token.propagation.enabled

micronaut.security.endpoints.oauth.get-allowed

boolean

Enables TokenPropagationHttpClientFilter. Default value false

micronaut.security.token.propagation.path

java.lang.String
- +@@ -716,9 +632,9 @@

Micronaut Security Config Propert

Table 18. Configuration Properties for LoginControllerConfigurationPropertiesTable 16. Configuration Properties for LoginControllerConfigurationProperties
-🔗 +🔗 - +@@ -733,24 +649,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 19. Configuration Properties for SecurityFilterConfigurationPropertiesTable 17. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationProperties

micronaut.security.filter.enabled

boolean

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.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.unauthorized.enabled

boolean

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

Micronaut Security Jwt Config Properties

-🔗 +🔗 - +@@ -765,26 +678,21 @@

Micronaut Security Jwt Config

- - - - - - - + + - - - + + +
Table 20. Configuration Properties for SecretEncryptionConfigurationTable 18. Configuration Properties for SecurityFilterConfigurationProperties

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

java.lang.String

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

com.nimbusds.jose.JWEAlgorithm

micronaut.security.filter.enabled

boolean

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

com.nimbusds.jose.EncryptionMethod

micronaut.security.filter.path

java.lang.String

Pattern the {@link SecurityFilter} should match. Default value /**. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED
-🔗 +🔗 - +@@ -799,46 +707,50 @@

Micronaut Security Jwt Config

- - - + + + - - - + + + - - - + + + - - - + + + - + - + - - - + + + - + - +
Table 21. Configuration Properties for JwtClaimsValidatorConfigurationPropertiesTable 19. Configuration Properties for SecurityConfigurationProperties

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.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.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.enabled

boolean

If Security is enabled. Default value true

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.intercept-url-map

java.util.List

Map that defines the interception patterns.

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

boolean

micronaut.security.ip-patterns

java.util.List

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

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

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

boolean

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

Whether the intercept URL patterns should be prepended with context path if defined. Defaults to 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.authentication-provider-strategy

AuthenticationStrategy

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

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

micronaut.security.reject-not-found

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.

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 Jwt Config Properties

+🔗 - +@@ -853,18 +765,18 @@

Micronaut Security Jwt Config

- - + + - - + + - - + + @@ -872,7 +784,7 @@

Micronaut Security Jwt Config
🔗

Table 22. Configuration Properties for SecretSignatureConfigurationTable 20. Configuration Properties for SecretEncryptionConfiguration

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

com.nimbusds.jose.JWSAlgorithm

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

java.lang.String

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

java.lang.String

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

com.nimbusds.jose.JWEAlgorithm

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

boolean

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

com.nimbusds.jose.EncryptionMethod
- +@@ -909,9 +821,9 @@

Micronaut Security Jwt Config

Table 23. Configuration Properties for RefreshTokenConfigurationPropertiesTable 21. Configuration Properties for RefreshTokenConfigurationProperties
-🔗 +🔗 - +@@ -926,21 +838,16 @@

Micronaut Security Jwt Config

- + - - - - - - +
Table 24. Configuration Properties for KeysControllerConfigurationPropertiesTable 22. Configuration Properties for JwtConfigurationProperties

micronaut.security.endpoints.keys.enabled

micronaut.security.token.jwt.enabled

boolean

micronaut.security.endpoints.keys.path

java.lang.String

Path to the KeysController. Default value "/keys".

Sets whether JWT security is enabled. Default value (true).
-🔗 +🔗 - +@@ -955,16 +862,46 @@

Micronaut Security Jwt Config

- + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + +
Table 25. Configuration Properties for JwtConfigurationPropertiesTable 23. Configuration Properties for JwtClaimsValidatorConfigurationProperties

micronaut.security.token.jwt.enabled

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

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

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

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.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.
-🔗 +🔗 - +@@ -979,18 +916,18 @@

Micronaut Security Jwt Config

- - - + + + - + - - + + @@ -998,7 +935,7 @@

Micronaut Security Jwt Config
🔗

Table 26. Configuration Properties for JwksSignatureConfigurationPropertiesTable 24. Configuration Properties for SecretSignatureConfiguration

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

java.lang.Integer

JWKS cache expiration. Default value 60 seconds.

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

com.nimbusds.jose.JWSAlgorithm

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

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

java.lang.String

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

com.nimbusds.jose.jwk.KeyType

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

boolean
- +@@ -1020,12 +957,9 @@

Micronaut Security Jwt Config

Table 27. Configuration Properties for StaticJwksSignatureConfigurationPropertiesTable 25. Configuration Properties for StaticJwksSignatureConfigurationProperties
-
-
-

Micronaut Security Ldap Config Properties

-🔗 +🔗 - +@@ -1040,36 +974,26 @@

Micronaut Security Ldap Conf

- - - - - - - - - - - - - + + + - + - - + +
Table 28. Configuration Properties for LdapConfiguration$ContextConfigurationTable 26. Configuration Properties for JwksSignatureConfigurationProperties

micronaut.security.ldap.*.context.server

java.lang.String

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

java.lang.String

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

java.lang.String

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

java.lang.Integer

JWKS cache expiration. Default value 60 seconds.

micronaut.security.ldap.*.context.factory

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

java.lang.String

micronaut.security.ldap.*.context.properties

java.util.Map

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

com.nimbusds.jose.jwk.KeyType
-🔗 +🔗 - +@@ -1084,41 +1008,24 @@

Micronaut Security Ldap Conf

- + - - - - - - - - - - - - - - - - - - - - - + - +
Table 29. Configuration Properties for LdapConfiguration$GroupConfigurationTable 27. Configuration Properties for KeysControllerConfigurationProperties

micronaut.security.ldap.*.groups.subtree

micronaut.security.endpoints.keys.enabled

boolean

micronaut.security.ldap.*.groups.base

java.lang.String

micronaut.security.ldap.*.groups.filter

java.lang.String

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

micronaut.security.endpoints.keys.path

java.lang.String

The argument to pass to the search filter.

Path to the KeysController. Default value "/keys".
+
+
+

Micronaut Security Ldap Config Properties

🔗 - +@@ -1155,9 +1062,9 @@

Micronaut Security Ldap Conf

Table 30. Configuration Properties for LdapConfiguration$SearchConfigurationTable 28. Configuration Properties for LdapConfiguration$SearchConfiguration
-🔗 +🔗 - +@@ -1172,19 +1079,36 @@

Micronaut Security Ldap Conf

- - - + + + + + + + + + + + + + + + + + + + + + + +
Table 31. Configuration Properties for LdapConfigurationTable 29. Configuration Properties for LdapConfiguration$ContextConfiguration

micronaut.security.ldap.*.enabled

boolean

Sets whether this configuration is enabled. Default true.

micronaut.security.ldap.*.context.server

java.lang.String

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

java.lang.String

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

java.lang.String

micronaut.security.ldap.*.context.factory

java.lang.String

micronaut.security.ldap.*.context.properties

java.util.Map
-
-
-

Micronaut Security Oauth2 Config Properties

-🔗 +🔗 - +@@ -1199,63 +1123,41 @@

Micronaut Security Oauth2

- + - + - + - + - + - + - + - + - -
Table 32. Configuration Properties for OauthConfigurationPropertiesTable 30. Configuration Properties for LdapConfiguration$GroupConfiguration

micronaut.security.oauth2.enabled

micronaut.security.ldap.*.groups.subtree

boolean

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

micronaut.security.oauth2.login-uri

micronaut.security.ldap.*.groups.base

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

micronaut.security.ldap.*.groups.filter

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.ldap.*.groups.attribute

java.lang.String

The default authentication provider for an OAuth 2.0 authorization code grant flow.
-
-🔗 - - ----- - - - - + + + - - - + - - - - - - +
Table 33. Configuration Properties for DefaultNonceConfiguration
PropertyTypeDescription

micronaut.security.ldap.*.groups.enabled

boolean

Sets if group search is enabled. Default false

micronaut.security.oauth2.openid.nonce.persistence

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

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.nonce.enabled

boolean

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

The argument to pass to the search filter.
-🔗 +🔗 - +@@ -1270,41 +1172,19 @@

Micronaut Security Oauth2

- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
Table 34. Configuration Properties for CookieStatePersistenceConfigurationTable 31. Configuration Properties for LdapConfiguration

micronaut.security.oauth2.state.cookie.cookie-domain

java.lang.String

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

micronaut.security.oauth2.state.cookie.cookie-secure

java.lang.Boolean

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

micronaut.security.oauth2.state.cookie.cookie-name

java.lang.String

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

micronaut.security.oauth2.state.cookie.cookie-path

java.lang.String

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

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

java.lang.Boolean

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

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

java.time.Duration

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

micronaut.security.ldap.*.enabled

boolean

Sets whether this configuration is enabled. Default true.
+
+
+

Micronaut Security Oauth2 Config Properties

🔗 - +@@ -1337,9 +1217,33 @@

Micronaut Security Oauth2

Table 35. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationPropertiesTable 32. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties
+🔗 + + +++++ + + + + + + + + + + + + + + +
Table 33. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$UserInfoEndpointConfigurationProperties
PropertyTypeDescription

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

java.lang.String

The endpoint URL

+
🔗 - +@@ -1374,9 +1278,9 @@

Micronaut Security Oauth2

Table 36. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$ClaimsValidationConfigurationPropertiesTable 34. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$ClaimsValidationConfigurationProperties
-🔗 +🔗 - +@@ -1391,16 +1295,26 @@

Micronaut Security Oauth2

- + + + + + + + + + + +
Table 37. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$UserInfoEndpointConfigurationPropertiesTable 35. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$TokenEndpointConfigurationProperties

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

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

java.lang.String

The endpoint URL

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

AuthenticationMethod

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).
-🔗 +🔗 - +@@ -1415,41 +1329,41 @@

Micronaut Security Oauth2

- + - + - + - + - + - + - +
Table 38. Configuration Properties for CookieNoncePersistenceConfigurationTable 36. Configuration Properties for CookiePkcePersistenceConfiguration

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

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

java.lang.String

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

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

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.openid.nonce.cookie.cookie-name

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

java.lang.String

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

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

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

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

java.lang.String

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

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

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.openid.nonce.cookie.cookie-max-age

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

java.time.Duration

Sets the maximum age of the cookie. Default value (5 minutes).
-🔗 +🔗 - +@@ -1464,42 +1378,21 @@

Micronaut Security Oauth2

- - - - - - - - - - - - - - - - + - + - + - - - - - - +
Table 39. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationPropertiesTable 37. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$EndSessionConfigurationProperties

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

java.lang.String

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

java.lang.String

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

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

java.lang.String

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

The endpoint URL

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

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

boolean

Enables ClientCredentialsClient. Default value true

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

java.util.Map

The end session enabled flag. Default value (true).
-🔗 +🔗 - +@@ -1514,36 +1407,46 @@

Micronaut Security Oauth2

- - - - - - + - + - + - + + +
Table 40. Configuration Properties for OauthClientConfigurationPropertiesTable 38. Configuration Properties for DefaultStateConfiguration

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

java.lang.String

OAuth 2.0 client id.

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

micronaut.security.oauth2.state.persistence

java.lang.String

OAuth 2.0 client secret.

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

micronaut.security.oauth2.clients.*.enabled

micronaut.security.oauth2.state.enabled

boolean

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

Sets whether a state parameter will be sent. Default (true).
+
+🔗 + + +++++ + - - - + + + + + - - - + + +
Table 39. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$EndSessionConfigurationProperties

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

PropertyTypeDescription

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

GrantType

OAuth 2.0 grant type. Default value (authorization_code).

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

java.lang.String

The URI the OpenID provider should redirect to after logging out. Default value ("/logout").
🔗 - +@@ -1599,16 +1502,116 @@

Micronaut Security Oauth2

- - - + + + + + +
Table 41. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$AuthorizationEndpointConfigurationPropertiesTable 40. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$AuthorizationEndpointConfigurationProperties

Authentication class reference values.

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

java.lang.String

Code Challenge Method to use for PKCE.

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

java.lang.String

Code Challenge Method to use for PKCE.

+
+🔗 + + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 41. Configuration Properties for OauthConfigurationProperties
PropertyTypeDescription

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

java.lang.String

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

+
+🔗 + + +++++ + + + + + + + + + + + + + + + + + + + +
Table 42. Configuration Properties for DefaultNonceConfiguration
PropertyTypeDescription

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.nonce.enabled

boolean

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

+
+🔗 + + +++++ + + + + + + + + + + + + + + + + +
Table 43. Configuration Properties for OauthClientConfigurationProperties$IntrospectionEndpointConfigurationProperties
PropertyTypeDescription

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

java.lang.String

The endpoint URL

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

AuthenticationMethod

Authentication Method
-🔗 +🔗 - +@@ -1623,12 +1626,12 @@

Micronaut Security Oauth2

- + - + @@ -1637,7 +1640,7 @@

Micronaut Security Oauth2
🔗

Table 42. Configuration Properties for OauthClientConfigurationProperties$TokenEndpointConfigurationPropertiesTable 44. 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

Authentication Method
- +@@ -1672,9 +1675,9 @@

Micronaut Security Oauth2

Table 43. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$AdditionalClaimsConfigurationPropertiesTable 45. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$AdditionalClaimsConfigurationProperties
-🔗 +🔗 - +@@ -1689,26 +1692,26 @@

Micronaut Security Oauth2

- - - + + + - - - + + + - - - + + +
Table 44. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$TokenEndpointConfigurationPropertiesTable 46. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties$HeaderTokenPropagatorConfigurationProperties

micronaut.security.oauth2.clients.*.openid.token.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.*.openid.token.auth-method

AuthenticationMethod

Authentication Method

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

java.lang.String

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.clients.*.client-credentials.header-propagation.header-name

java.lang.String
-🔗 +🔗 - +@@ -1723,16 +1726,41 @@

Micronaut Security Oauth2

- + - + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 45. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationPropertiesTable 47. Configuration Properties for CookieStatePersistenceConfiguration

micronaut.security.oauth2.openid.logout-uri

micronaut.security.oauth2.state.cookie.cookie-domain

java.lang.String

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

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

micronaut.security.oauth2.state.cookie.cookie-secure

java.lang.Boolean

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

micronaut.security.oauth2.state.cookie.cookie-name

java.lang.String

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

micronaut.security.oauth2.state.cookie.cookie-path

java.lang.String

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

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

java.lang.Boolean

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

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

java.time.Duration

Sets the maximum age of the cookie. Default value (5 minutes).
-🔗 +🔗 - +@@ -1747,21 +1775,27 @@

Micronaut Security Oauth2

- - - + + + - + - + + + + + +
Table 46. Configuration Properties for OauthClientConfigurationProperties$AuthorizationEndpointConfigurationPropertiesTable 48. Configuration Properties for PkceConfigurationProperties

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

java.lang.String

The endpoint URL

micronaut.security.oauth2.pkce.entropy

int

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

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

micronaut.security.oauth2.pkce.persistence

java.lang.String

Code Challenge Method to use for PKCE.

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

boolean

Sets whether a state parameter will be sent. Default (true).
-🔗 +🔗 - +@@ -1776,21 +1810,21 @@

Micronaut Security Oauth2

- + - +
Table 47. Configuration Properties for OauthClientConfigurationProperties$RevocationEndpointConfigurationPropertiesTable 49. Configuration Properties for OauthClientConfigurationProperties$TokenEndpointConfigurationProperties

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

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

java.lang.String

The endpoint URL

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

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

AuthenticationMethod

Authentication Method
-🔗 +🔗 - +@@ -1805,45 +1839,41 @@

Micronaut Security Oauth2

- + - + - -
Table 48. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$RegistrationEndpointConfigurationPropertiesTable 50. Configuration Properties for CookieNoncePersistenceConfiguration

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

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

java.lang.String

The endpoint URL

Sets the domain name of this Cookie. Default value (null).
-
-🔗 - - ----- - - - - + + + - - - + - + - - - + + + + + + + + + + + + +
Table 49. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$EndSessionConfigurationProperties
PropertyTypeDescription

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.clients.*.openid.end-session.url

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

java.lang.String

The endpoint URL

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

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

boolean

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

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

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).
-🔗 +🔗 - +@@ -1858,27 +1888,21 @@

Micronaut Security Oauth2

- - - - - - + - + - - - + + +
Table 50. Configuration Properties for PkceConfigurationPropertiesTable 51. Configuration Properties for OauthClientConfigurationProperties$AuthorizationEndpointConfigurationProperties

micronaut.security.oauth2.pkce.entropy

int

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

micronaut.security.oauth2.pkce.persistence

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

java.lang.String

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

The endpoint URL

micronaut.security.oauth2.pkce.enabled

boolean

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

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

java.lang.String

Code Challenge Method to use for PKCE.
-🔗 +🔗 - +@@ -1893,26 +1917,16 @@

Micronaut Security Oauth2

- - - - - - - - - - - + - +
Table 51. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties$HeaderTokenPropagatorConfigurationPropertiesTable 52. Configuration Properties for OauthClientConfigurationProperties$OpenIdClientConfigurationProperties$RegistrationEndpointConfigurationProperties

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

boolean

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

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

java.lang.String

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

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

java.lang.String

The endpoint URL
-🔗 +🔗 - +@@ -1927,41 +1941,42 @@

Micronaut Security Oauth2

- + - + - - - + + + - - - + + + - + - + - - - + + + - - - + + +
Table 52. Configuration Properties for CookiePkcePersistenceConfigurationTable 53. Configuration Properties for OauthClientConfigurationProperties$ClientCredentialsConfigurationProperties

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

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

java.lang.String

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

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.clients.*.client-credentials.uri-regex

java.lang.String

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

java.lang.String

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

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.pkce.cookie.cookie-path

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

java.lang.String

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

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

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.*.client-credentials.enabled

boolean

Enables ClientCredentialsClient. Default value true

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

java.time.Duration

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

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

java.util.Map
-🔗 +🔗 - +@@ -1976,22 +1991,16 @@

Micronaut Security Oauth2

- + - - - - - - +
Table 53. Configuration Properties for DefaultStateConfigurationTable 54. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties

micronaut.security.oauth2.state.persistence

micronaut.security.oauth2.openid.logout-uri

java.lang.String

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

micronaut.security.oauth2.state.enabled

boolean

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

The URI used to log out of an OpenID provider. Default value ("/oauth/logout").
-🔗 +🔗 - +@@ -2006,38 +2015,29 @@

Micronaut Security Oauth2

- + - + - -
Table 54. Configuration Properties for OauthConfigurationProperties$OpenIdConfigurationProperties$EndSessionConfigurationPropertiesTable 55. Configuration Properties for OauthClientConfigurationProperties

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

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

java.lang.String

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

OAuth 2.0 client id.
-
-🔗 - - ----- - - - - + + + - - - - - + + + - - - + + + + + + + +
Table 55. Configuration Properties for OauthClientConfigurationProperties$IntrospectionEndpointConfigurationProperties
PropertyTypeDescription

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

java.lang.String

OAuth 2.0 client secret.

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

java.lang.String

The endpoint URL

micronaut.security.oauth2.clients.*.enabled

boolean

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

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

AuthenticationMethod

Authentication Method

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).