diff --git a/snapshot/guide/configurationreference.html b/snapshot/guide/configurationreference.html index bb06ab7a5b..71ec50a8d3 100644 --- a/snapshot/guide/configurationreference.html +++ b/snapshot/guide/configurationreference.html @@ -51,9 +51,9 @@
|
+
|
boolean |
||
|
+
|
java.lang.String |
-Pattern the {@link SecurityFilter} should match. Default value |
+Sets the path to map the {@link OauthController} to. Default value ("/oauth/access_token"). |
+
|
+boolean |
+
|
+
|
boolean |
||
|
+
|
java.lang.String |
-Path to the IntrospectionController. Default value "/token_info" |
+Path to the LoginController. Default value "/login" |
|
-java.lang.String |
-- | |||
|
-java.lang.Boolean |
-+ |
|
++ | 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. |
|
-java.lang.Boolean |
-+ |
|
+boolean |
+If Security is enabled. Default value true |
|
-java.time.Duration |
-+ |
|
+java.util.List |
+Map that defines the interception patterns. |
|
-- | Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: |
+
|
+java.util.List |
+Allowed IP patterns. Default value (["0.0.0.0"]) |
|
+
|
boolean |
-+ | Whether the intercept URL patterns should be prepended with context path if defined. Defaults to true. |
|
|
-java.lang.String |
-+ |
|
++ | Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL. |
|
-java.lang.String |
-+ |
|
+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). |
|
+
|
java.lang.String |
-Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/"). |
+Where the user is redirected to after trying to access a secured route. Default value ("/"). |
|
+
|
boolean |
-Whether it should redirect on forbidden rejections. Default value (true). |
+Whether it should redirect on unauthorized rejections. Default value (true). |
|
-- | 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. |
+
|
+java.lang.String |
+|
|
-boolean |
-If Security is enabled. Default value true |
+
|
+java.lang.String |
+|
|
-java.util.List |
-Map that defines the interception patterns. |
+
|
+java.util.regex.Pattern |
+|
|
-java.util.List |
-Allowed IP patterns. Default value (["0.0.0.0"]) |
+
|
+java.util.regex.Pattern |
+|
|
+
|
boolean |
-Whether the intercept URL patterns should be prepended with context path if defined. Defaults to true. |
-||
|
-- | Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL. |
+Enables TokenPropagationHttpClientFilter. Default value false |
||
|
-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). |
+
|
+java.lang.String |
+
|
-java.lang.String |
-- | |||
|
-java.lang.Boolean |
-- | |||
|
-java.lang.Boolean |
-- | |||
|
-java.time.Duration |
-+ |
|
+java.lang.Integer |
+Access token expiration. Default value (3600). |
|
-- | Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: |
+Property | +Type | +Description |
---|---|---|---|---|---|
|
+
|
boolean |
-+ | Enable HttpHeaderTokenPropagator. Default value (true). |
|
|
+
|
java.lang.String |
|||
|
+
|
java.lang.String |
|
+
|
boolean |
||
|
+
|
java.lang.String |
-Path to the LoginController. Default value "/login" |
+Path to the IntrospectionController. Default value "/token_info" |
|
+
|
boolean |
-Enable HttpHeaderTokenPropagator. Default value (true). |
-|
|
-java.lang.String |
|||
|
+
|
java.lang.String |
-+ | Pattern the {@link SecurityFilter} should match. Default value |
|
+
|
boolean |
-+ | Set whether to enable bearer token authentication. Default value true. |
|
|
+
|
java.lang.String |
-Sets the path to map the {@link OauthController} to. Default value ("/oauth/access_token"). |
+Sets the prefix to use for the auth token. Default value Bearer. |
|
|
-boolean |
-+ |
|
+java.lang.String |
+Sets the header name to use. Default value Authorization. |
|
+
|
boolean |
-Set whether to enable bearer token authentication. Default value true. |
-
|
-java.lang.String |
-Sets the prefix to use for the auth token. Default value Bearer. |
-|
|
-java.lang.String |
-Sets the header name to use. Default value Authorization. |
+Enables the {@link BasicAuthAuthenticationFetcher}. Default value true. |
|
-java.lang.String |
-- | |
|
+
|
java.lang.String |
-- |
|
-java.util.regex.Pattern |
-- | |
|
-java.util.regex.Pattern |
-+ | Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/"). |
|
+
|
boolean |
-Enables TokenPropagationHttpClientFilter. Default value false |
-
|
-java.lang.String |
-+ | Whether it should redirect on forbidden rejections. Default value (true). |
Property | -Type | -Description | -
---|---|---|
|
-java.lang.Integer |
-Access token expiration. Default value (3600). |
-
|
+
|
+java.lang.String |
++ |
|
+java.lang.Boolean |
++ | |
|
+java.lang.Boolean |
++ | |
|
+java.time.Duration |
++ | |
|
++ | Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: |
+|
|
boolean |
-Enables the {@link BasicAuthAuthenticationFetcher}. Default value true. |
++ |
|
+java.lang.String |
++ | |
|
+java.lang.String |
+
|
+
|
java.lang.String |
-Where the user is redirected to after trying to access a secured route. Default value ("/"). |
+|
|
+
|
+java.lang.Boolean |
++ | |
|
+java.lang.Boolean |
++ | ||
|
+java.time.Duration |
++ | ||
|
++ | Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: |
+||
|
boolean |
-Whether it should redirect on unauthorized rejections. Default value (true). |
++ | |
|
+java.lang.String |
++ | ||
|
+java.lang.String |
+
|
-com.nimbusds.jose.JWSAlgorithm |
-+ |
|
+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. |
|
+
|
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. |
|
|
+
|
+boolean |
+Whether the JWT subject claim should be validated to ensure it is not null. Default value true. |
+||
|
boolean |
||||
|
+boolean |
+Whether the expiration date of the JWT should be validated. Default value true. |
+|||
|
+boolean |
+Whether the nonce claim should be validated when a nonce was present. Default value true. |
+|||
|
+boolean |
+Whether |
+
|
-boolean |
-+ |
|
+java.lang.Integer |
+JWKS cache expiration. Default value 60 seconds. |
|
+
|
java.lang.String |
-Path to the KeysController. Default value "/keys". |
++ | |
|
+com.nimbusds.jose.jwk.KeyType |
+
|
-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. |
-|||
|
+
|
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. |
-||
|
-boolean |
-Whether the JWT subject claim should be validated to ensure it is not null. Default value true. |
-|||
|
-boolean |
||||
|
-boolean |
-Whether the expiration date of the JWT should be validated. Default value true. |
-|||
|
-boolean |
-Whether the nonce claim should be validated when a nonce was present. Default value true. |
+
|
+com.nimbusds.jose.JWEAlgorithm |
+|
|
-boolean |
-Whether |
+
|
+com.nimbusds.jose.EncryptionMethod |
+
|
-boolean |
-Sets whether SignedRefreshTokenGenerator is enabled. Default value (true). |
-||
|
+
|
com.nimbusds.jose.JWSAlgorithm |
-{@link com.nimbusds.jose.JWSAlgorithm}. Defaults to HS256 |
+|
|
+
|
java.lang.String |
-shared secret. For HS256 must be at least 256 bits. |
+|
|
+
|
boolean |
-Indicates whether the supplied secret is base64 encoded. Default value false. |
+
|
-java.lang.Integer |
-JWKS cache expiration. Default value 60 seconds. |
+
|
+boolean |
+Sets whether SignedRefreshTokenGenerator is enabled. Default value (true). |
|
+
|
+com.nimbusds.jose.JWSAlgorithm |
+{@link com.nimbusds.jose.JWSAlgorithm}. Defaults to HS256 |
+||
|
java.lang.String |
-+ | shared secret. For HS256 must be at least 256 bits. |
||
|
-com.nimbusds.jose.jwk.KeyType |
-+ |
|
+boolean |
+Indicates whether the supplied secret is base64 encoded. Default value false. |
|
-java.lang.String |
-- | |||
|
-com.nimbusds.jose.JWEAlgorithm |
+
|
+boolean |
||
|
-com.nimbusds.jose.EncryptionMethod |
-+ |
|
+java.lang.String |
+Path to the KeysController. Default value "/keys". |
|
+
|
boolean |
-Sets whether this configuration is enabled. Default true. |
++ |
|
+java.lang.String |
++ | ||
|
+java.lang.String |
++ | ||
|
+java.lang.String |
+
|
+
|
boolean |
-+ | Sets whether this configuration is enabled. Default true. |
+
Property | +Type | +Description | ||
---|---|---|---|---|
|
+
|
+boolean |
+Sets whether the OAuth 2.0 support is enabled. Default value (true). |
+|
|
java.lang.String |
-+ | The URI template that is used to initiate an OAuth 2.0 + authorization code grant flow. Default value ("/oauth/login{/provider}"). |
|
|
+
|
java.lang.String |
-+ | The URI template that OAuth 2.0 providers can use to + submit an authorization callback request. Default value ("/oauth/callback{/provider}"). |
|
+
|
java.lang.String |
-+ | The default authentication provider for an OAuth 2.0 authorization code grant flow. |
|
+
|
java.lang.String |
Sets the domain name of this Cookie. Default value (null). |
|
|
+
|
java.lang.Boolean |
Sets whether the cookie is secured. Defaults to the secure status of the request. |
|
|
+
|
java.lang.String |
-Cookie Name. Default value |
+Cookie Name. Default value |
|
+
|
java.lang.String |
Sets the path of the cookie. Default value ("/"). |
|
|
+
|
java.lang.Boolean |
Whether the Cookie can only be accessed via HTTP. Default value (true). |
|
|
+
|
java.time.Duration |
Sets the maximum age of the cookie. Default value (5 minutes). |
|
+
|
java.lang.String |
The endpoint URL |
||
|
-- | Authentication Method |
+
|
++ | Determines the authorization processing flow to be used. Default value (code). |
Property | -Type | -Description | +
|
+java.lang.String |
+Mechanism to be used for returning authorization response parameters from the + authorization endpoint. |
---|---|---|---|---|---|
|
-java.net.URL |
-URL using the https scheme with no query or fragment component that the - Open ID provider asserts as its issuer identifier. |
+
|
++ | Controls how the authentication interface is displayed. |
|
-java.lang.String |
-The configuration path to discover openid configuration. Default ("/.well-known/openid-configuration"). |
+
|
++ | Controls how the authentication server prompts the user. |
|
+
|
+java.lang.Integer |
+Maximum authentication age. |
+||
|
+java.util.List |
+Preferred locales for authentication. |
+|||
|
+java.util.List |
+Authentication class reference values. |
+|||
|
java.lang.String |
-The JWKS signature URI. |
+Code Challenge Method to use for PKCE. |
|
+
|
java.lang.String |
The endpoint URL |
|
+
|
Authentication Method |
|
+
|
+java.net.URL |
+URL using the https scheme with no query or fragment component that the + Open ID provider asserts as its issuer identifier. |
+||
|
java.lang.String |
-Sets the mechanism to persist the nonce for later retrieval for validation. - Supported values ("session", "cookie"). Default value ("cookie"). |
+The configuration path to discover openid configuration. Default ("/.well-known/openid-configuration"). |
||
|
-boolean |
-Sets whether a nonce parameter will be sent. Default (true). |
+
|
+java.lang.String |
+The JWKS signature URI. |
|
+
|
java.lang.String |
-OAuth 2.0 client id. |
+The endpoint URL |
|
+
|
java.lang.String |
-OAuth 2.0 client secret. |
-|
|
-boolean |
-Sets whether the client is enabled. Default value (true). |
-||
|
-java.util.List |
-Requested scopes. If not specified for OAuth 2.0 clients using OpenID Connect it defaults to |
-||
|
-- | OAuth 2.0 grant type. Default value (authorization_code). |
+Code Challenge Method to use for PKCE. |
|
-java.lang.String |
-The endpoint URL |
+
|
+boolean |
+Whether IssuerClaimValidator + is enabled. Default value (true). |
|
-- | Authentication Method |
+
|
+boolean |
+Whether AudienceClaimValidator + is enabled. Default value (true). |
+
|
+boolean |
+Whether AuthorizedPartyClaimValidator + is enabled. Default value (true). |
|
+
|
java.lang.String |
-The endpoint URL |
-
|
-boolean |
-The end session enabled flag. Default value (true). |
+The URI used to log out of an OpenID provider. Default value ("/oauth/logout"). |
|
-boolean |
-Sets whether the OAuth 2.0 support is enabled. Default value (true). |
-|||
|
-java.lang.String |
-The URI template that is used to initiate an OAuth 2.0 - authorization code grant flow. Default value ("/oauth/login{/provider}"). |
+
|
+int |
+entropy (in bytes) used for the code verifier generation. Default value 64. |
|
+
|
java.lang.String |
-The URI template that OAuth 2.0 providers can use to - submit an authorization callback request. Default value ("/oauth/callback{/provider}"). |
+Sets the mechanism to persist the state for later retrieval for validation. + Supported values ("session", "cookie"). Default value (PERSISTENCE_COOKIE). |
|
|
-java.lang.String |
-The default authentication provider for an OAuth 2.0 authorization code grant flow. |
+
|
+boolean |
+Sets whether a state parameter will be sent. Default (true). |
|
-boolean |
-Whether IssuerClaimValidator - is enabled. Default value (true). |
-|||
|
-boolean |
-Whether AudienceClaimValidator - is enabled. Default value (true). |
+
|
+java.lang.String |
+Sets the mechanism to persist the nonce for later retrieval for validation. + Supported values ("session", "cookie"). Default value ("cookie"). |
|
+
|
boolean |
-Whether AuthorizedPartyClaimValidator - is enabled. Default value (true). |
+Sets whether a nonce parameter will be sent. Default (true). |
|
+
|
java.lang.String |
The endpoint URL |
||
|
-- | Determines the authorization processing flow to be used. Default value (code). |
-|||
|
-java.lang.String |
-Mechanism to be used for returning authorization response parameters from the - authorization endpoint. |
-|||
|
-- | Controls how the authentication interface is displayed. |
-|||
|
-- | Controls how the authentication server prompts the user. |
-|||
|
-java.lang.Integer |
-Maximum authentication age. |
-|||
|
-java.util.List |
-Preferred locales for authentication. |
-|||
|
-java.util.List |
-Authentication class reference values. |
-|||
|
-java.lang.String |
-Code Challenge Method to use for PKCE. |
+
|
++ | Authentication Method |
|
+
|
java.lang.String |
-The endpoint URL |
+The URI the OpenID provider should redirect to after logging out. Default value ("/logout"). |
|
-java.lang.String |
-Sets the domain name of this Cookie. Default value (null). |
-|||
|
-java.lang.Boolean |
-Sets whether the cookie is secured. Defaults to the secure status of the request. |
-|||
|
-java.lang.String |
-Cookie Name. Default value |
-|||
|
+
|
java.lang.String |
-Sets the path of the cookie. Default value ("/"). |
-||
|
-java.lang.Boolean |
-Whether the Cookie can only be accessed via HTTP. Default value (true). |
+The endpoint URL |
||
|
-java.time.Duration |
-Sets the maximum age of the cookie. Default value (5 minutes). |
+
|
++ | Authentication Method |
|
+
|
java.lang.String |
-The endpoint URL |
+Sets the mechanism to persist the state for later retrieval for validation. + Supported values ("session", "cookie"). Default value ("cookie"). |
+
|
+boolean |
+Sets whether a state parameter will be sent. Default (true). |
|
+
|
+boolean |
+Enable {@link ClientCredentialsHeaderTokenPropagatorConfiguration}. Default value (true). |
+
|
java.lang.String |
-The URI used to log out of an OpenID provider. Default value ("/oauth/logout"). |
++ |
|
+java.lang.String |
+
|
-int |
-entropy (in bytes) used for the code verifier generation. Default value 64. |
-|
|
+
|
java.lang.String |
-Sets the mechanism to persist the state for later retrieval for validation. - Supported values ("session", "cookie"). Default value (PERSISTENCE_COOKIE). |
-
|
-boolean |
-Sets whether a state parameter will be sent. Default (true). |
+The endpoint URL |
|
+
|
java.lang.String |
Sets the domain name of this Cookie. Default value (null). |
|
|
+
|
java.lang.Boolean |
Sets whether the cookie is secured. Defaults to the secure status of the request. |
|
|
+
|
java.lang.String |
-Cookie Name. Default value |
+Cookie Name. Default value |
|
+
|
java.lang.String |
Sets the path of the cookie. Default value ("/"). |
|
|
+
|
java.lang.Boolean |
Whether the Cookie can only be accessed via HTTP. Default value (true). |
|
|
+
|
java.time.Duration |
Sets the maximum age of the cookie. Default value (5 minutes). |
|
+
|
java.lang.String |
-The endpoint URL |
+Sets the domain name of this Cookie. Default value (null). |
|
+
|
+java.lang.Boolean |
+Sets whether the cookie is secured. Defaults to the secure status of the request. |
+|
|
java.lang.String |
-Code Challenge Method to use for PKCE. |
+Cookie Name. Default value |
+|
|
+java.lang.String |
+Sets the path of the cookie. Default value ("/"). |
+||
|
+java.lang.Boolean |
+Whether the Cookie can only be accessed via HTTP. Default value (true). |
+||
|
+java.time.Duration |
+Sets the maximum age of the cookie. Default value (5 minutes). |
|
+
|
java.lang.String |
-The URI the OpenID provider should redirect to after logging out. Default value ("/logout"). |
+The endpoint URL |
+
|
+boolean |
+The end session enabled flag. Default value (true). |
|
-boolean |
-Enable {@link ClientCredentialsHeaderTokenPropagatorConfiguration}. Default value (true). |
+
|
+java.lang.String |
+|
|
+
|
java.lang.String |
|||
|
+
|
+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). |
+||
|
java.lang.String |
+Scope to be requested in the client credentials request. Defaults to none. |
+|||
|
+boolean |
+Enables ClientCredentialsClient. Default value true |
+|||
|
+java.util.Map |
|
-java.lang.String |
-Sets the mechanism to persist the state for later retrieval for validation. - Supported values ("session", "cookie"). Default value ("cookie"). |
+
|
+boolean |
+Set to true if the original JWT from the provider should be included in the Micronaut JWT. + Default value (false). |
|
+
|
boolean |
-Sets whether a state parameter will be sent. Default (true). |
+Set to true if the original access token from the provider should be included in the Micronaut JWT. + Default value (false). |
+|
|
+boolean |
+Set to true if the original refresh token from the provider should be included in the Micronaut JWT. + Default value (false). |
|
+
|
java.lang.String |
-+ | OAuth 2.0 client id. |
|
|
+
|
java.lang.String |
-- | ||
|
-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). |
+OAuth 2.0 client secret. |
||
|
-java.lang.String |
-Scope to be requested in the client credentials request. Defaults to none. |
+
|
+boolean |
+Sets whether the client is enabled. Default value (true). |
|
-boolean |
-Enables ClientCredentialsClient. Default value true |
+
|
+java.util.List |
+Requested scopes. If not specified for OAuth 2.0 clients using OpenID Connect it defaults to |
|
-java.util.Map |
-+ |
|
++ | OAuth 2.0 grant type. Default value (authorization_code). |
|
-boolean |
-Set to true if the original JWT from the provider should be included in the Micronaut JWT. - Default value (false). |
-|||
|
-boolean |
-Set to true if the original access token from the provider should be included in the Micronaut JWT. - Default value (false). |
-|||
|
-boolean |
-Set to true if the original refresh token from the provider should be included in the Micronaut JWT. - Default value (false). |
+
|
+java.lang.String |
+The endpoint URL |