By Version

Edit this Page

OpenID Connect (OIDC) configuration properties

As a Quarkus developer, you configure the Quarkus OpenID Connect (OIDC) extension by setting the following properties in the src/main/resources/application.properties file.

OIDC configuration

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property	Type	Default
`quarkus.oidc.enabled` If the OIDC extension is enabled. Environment variable: `QUARKUS_OIDC_ENABLED` Show more	boolean	`true`
`quarkus.oidc.devui.grant.type` Grant type which will be used to acquire a token to test the OIDC 'service' applications Environment variable: `QUARKUS_OIDC_DEVUI_GRANT_TYPE` Show more	`client`'client_credentials' grant, `password`'password' grant, `code`'authorization_code' grant, `implicit`'implicit' grant
`quarkus.oidc.devui.grant-options."option-name"` Grant options Environment variable: `QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_` Show more	Map<String,Map<String,String>>
`quarkus.oidc.devui.web-client-timeout` The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. Environment variable: `QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT` Show more	Duration	`4S`
`quarkus.oidc.default-token-cache-enabled` Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note: This only enables the default implementation. It requires configuration to be activated. See `OidcConfig#tokenCache`. Environment variable: `QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED` Show more	boolean	`true`
`quarkus.oidc.auth-server-url` The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/{realm}`, replacing `{realm}` with the Keycloak realm name. Environment variable: `QUARKUS_OIDC_AUTH_SERVER_URL` Show more	string
`quarkus.oidc.discovery-enabled` Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. Environment variable: `QUARKUS_OIDC_DISCOVERY_ENABLED` Show more	boolean	`true`
`quarkus.oidc.registration-path` The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. Environment variable: `QUARKUS_OIDC_REGISTRATION_PATH` Show more	string
`quarkus.oidc.connection-delay` The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. Environment variable: `QUARKUS_OIDC_CONNECTION_DELAY` Show more	Duration
`quarkus.oidc.connection-retry-count` The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. Environment variable: `QUARKUS_OIDC_CONNECTION_RETRY_COUNT` Show more	int	`3`
`quarkus.oidc.connection-timeout` The number of seconds after which the current OIDC connection request times out. Environment variable: `QUARKUS_OIDC_CONNECTION_TIMEOUT` Show more	Duration	`10S`
`quarkus.oidc.use-blocking-dns-lookup` Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. Environment variable: `QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP` Show more	boolean	`false`
`quarkus.oidc.max-pool-size` The maximum size of the connection pool used by the WebClient. Environment variable: `QUARKUS_OIDC_MAX_POOL_SIZE` Show more	int
`quarkus.oidc.proxy.host` The host name or IP address of the Proxy. Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. Environment variable: `QUARKUS_OIDC_PROXY_HOST` Show more	string
`quarkus.oidc.proxy.port` The port number of the Proxy. The default value is `80`. Environment variable: `QUARKUS_OIDC_PROXY_PORT` Show more	int	`80`
`quarkus.oidc.proxy.username` The username, if the Proxy needs authentication. Environment variable: `QUARKUS_OIDC_PROXY_USERNAME` Show more	string
`quarkus.oidc.proxy.password` The password, if the Proxy needs authentication. Environment variable: `QUARKUS_OIDC_PROXY_PASSWORD` Show more	string
`quarkus.oidc.tls.tls-configuration-name` The name of the TLS configuration to use. If a name is configured, it uses the configuration from `quarkus.tls.<name>.` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. The default TLS configuration is not* used by default. Environment variable: `QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME` Show more	string
`quarkus.oidc.token-path` The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. Environment variable: `QUARKUS_OIDC_TOKEN_PATH` Show more	string
`quarkus.oidc.revoke-path` The relative path or absolute URL of the OIDC token revocation endpoint. Environment variable: `QUARKUS_OIDC_REVOKE_PATH` Show more	string
`quarkus.oidc.client-id` The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. Environment variable: `QUARKUS_OIDC_CLIENT_ID` Show more	string
`quarkus.oidc.client-name` The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider’s dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. Environment variable: `QUARKUS_OIDC_CLIENT_NAME` Show more	string
`quarkus.oidc.credentials.secret` The client secret used by the `client_secret_basic` authentication method. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. You can use `client-secret.value` instead, but both properties are mutually exclusive. Environment variable: `QUARKUS_OIDC_CREDENTIALS_SECRET` Show more	string
`quarkus.oidc.credentials.client-secret.value` The client secret value. This value is ignored if `credentials.secret` is set. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. Environment variable: `QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE` Show more	string
`quarkus.oidc.credentials.client-secret.provider.name` The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered Environment variable: `QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME` Show more	string
`quarkus.oidc.credentials.client-secret.provider.keyring-name` The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager Environment variable: `QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME` Show more	string
`quarkus.oidc.credentials.client-secret.provider.key` The CredentialsProvider client secret key Environment variable: `QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY` Show more	string
`quarkus.oidc.credentials.client-secret.method` The authentication method. If the `clientSecret.value` secret is set, this method is `basic` by default. Environment variable: `QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD` Show more	`basicclient_secret_basic` (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme., `postclient_secret_post`\: The client id and secret are submitted as the `client_id` and `client_secret` form parameters., `post-jwtclient_secret_jwt`\: The client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters., `query`client id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.
`quarkus.oidc.credentials.jwt.source` JWT token source: OIDC provider client or an existing JWT bearer token. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE` Show more	`client`, `bearer`	`client`
`quarkus.oidc.credentials.jwt.secret` If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SECRET` Show more	string
`quarkus.oidc.credentials.jwt.secret-provider.name` The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME` Show more	string
`quarkus.oidc.credentials.jwt.secret-provider.keyring-name` The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME` Show more	string
`quarkus.oidc.credentials.jwt.secret-provider.key` The CredentialsProvider client secret key Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY` Show more	string
`quarkus.oidc.credentials.jwt.key` String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_KEY` Show more	string
`quarkus.oidc.credentials.jwt.key-file` If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE` Show more	string
`quarkus.oidc.credentials.jwt.key-store-file` If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE` Show more	string
`quarkus.oidc.credentials.jwt.key-store-password` A parameter to specify the password of the keystore file. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD` Show more	string
`quarkus.oidc.credentials.jwt.key-id` The private key id or alias. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID` Show more	string
`quarkus.oidc.credentials.jwt.key-password` The private key password. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD` Show more	string
`quarkus.oidc.credentials.jwt.audience` The JWT audience (`aud`) claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE` Show more	string
`quarkus.oidc.credentials.jwt.token-key-id` The key identifier of the signing key added as a JWT `kid` header. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID` Show more	string
`quarkus.oidc.credentials.jwt.issuer` The issuer of the signing key added as a JWT `iss` claim. The default value is the client id. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER` Show more	string
`quarkus.oidc.credentials.jwt.subject` Subject of the signing key added as a JWT `sub` claim The default value is the client id. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT` Show more	string
`quarkus.oidc.credentials.jwt.claims."claim-name"` Additional claims. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_` Show more	Map<String,String>
`quarkus.oidc.credentials.jwt.signature-algorithm` The signature algorithm used for the `key-file` property. Supported values: `RS256` (default), `RS384`, `RS512`, `PS256`, `PS384`, `PS512`, `ES256`, `ES384`, `ES512`, `HS256`, `HS384`, `HS512`. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM` Show more	string
`quarkus.oidc.credentials.jwt.lifespan` The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN` Show more	int	`10`
`quarkus.oidc.credentials.jwt.assertion` If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension. Environment variable: `QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION` Show more	boolean	`false`
`quarkus.oidc.tenant-id` A unique tenant identifier. It can be set by `TenantConfigResolver` providers, which resolve the tenant configuration dynamically. Environment variable: `QUARKUS_OIDC_TENANT_ID` Show more	string
`quarkus.oidc.tenant-enabled` If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a `TenantConfigResolver` that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant. Environment variable: `QUARKUS_OIDC_TENANT_ENABLED` Show more	boolean	`true`
`quarkus.oidc.application-type` The application type, which can be one of the following `ApplicationType` values. Environment variable: `QUARKUS_OIDC_APPLICATION_TYPE` Show more	`web-app`A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users., `service`A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users., `hybrid`A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.	`service`A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.
`quarkus.oidc.authorization-path` The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for `web-app` applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled. Environment variable: `QUARKUS_OIDC_AUTHORIZATION_PATH` Show more	string
`quarkus.oidc.user-info-path` The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for `web-app` applications if OIDC discovery is disabled and the `authentication.user-info-required` property is enabled. This property is ignored if OIDC discovery is enabled. Environment variable: `QUARKUS_OIDC_USER_INFO_PATH` Show more	string
`quarkus.oidc.introspection-path` Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled. Environment variable: `QUARKUS_OIDC_INTROSPECTION_PATH` Show more	string
`quarkus.oidc.jwks-path` Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled. Environment variable: `QUARKUS_OIDC_JWKS_PATH` Show more	string
`quarkus.oidc.end-session-path` Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the `web-app` applications is required. This property is ignored if the discovery is enabled. Environment variable: `QUARKUS_OIDC_END_SESSION_PATH` Show more	string
`quarkus.oidc.tenant-paths` The paths which must be secured by this tenant. Tenant with the most specific path wins. Please see the Configure tenant paths section of the OIDC multitenancy guide for explanation of allowed path patterns. Environment variable: `QUARKUS_OIDC_TENANT_PATHS` Show more	list of string
`quarkus.oidc.public-key` The public key for the local JWT token verification. OIDC server connection is not created when this property is set. Environment variable: `QUARKUS_OIDC_PUBLIC_KEY` Show more	string
`quarkus.oidc.introspection-credentials.name` Name Environment variable: `QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_NAME` Show more	string
`quarkus.oidc.introspection-credentials.secret` Secret Environment variable: `QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_SECRET` Show more	string
`quarkus.oidc.introspection-credentials.include-client-id` Include OpenId Connect Client ID configured with `quarkus.oidc.client-id`. Environment variable: `QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID` Show more	boolean	`true`
`quarkus.oidc.roles.role-claim-path` A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no `groups` claim but has the groups set in one or more different claims. Environment variable: `QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH` Show more	list of string
`quarkus.oidc.roles.role-claim-separator` The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard `scope` claim can contain a space-separated sequence. Environment variable: `QUARKUS_OIDC_ROLES_ROLE_CLAIM_SEPARATOR` Show more	string
`quarkus.oidc.roles.source` Source of the principal roles. Environment variable: `QUARKUS_OIDC_ROLES_SOURCE` Show more	`idtoken`ID Token - the default value for the `web-app` applications., `accesstoken`Access Token - the default value for the `service` applications; can also be used as the source of roles for the `web-app` applications., `userinfo`User Info
`quarkus.oidc.token.issuer` The expected issuer `iss` claim value. This property overrides the `issuer` property, which might be set in OpenId Connect provider’s well-known configuration. If the `iss` claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to `any`, but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible. Environment variable: `QUARKUS_OIDC_TOKEN_ISSUER` Show more	string
`quarkus.oidc.token.audience` The expected audience `aud` claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured. Environment variable: `QUARKUS_OIDC_TOKEN_AUDIENCE` Show more	list of string
`quarkus.oidc.token.subject-required` Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo `sub` claims must be present and match each other. Environment variable: `QUARKUS_OIDC_TOKEN_SUBJECT_REQUIRED` Show more	boolean	`false`
`quarkus.oidc.token.required-claims."claim-name"` A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims. Environment variable: `QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_` Show more	Map<String,String>
`quarkus.oidc.token.token-type` Expected token type Environment variable: `QUARKUS_OIDC_TOKEN_TOKEN_TYPE` Show more	string
`quarkus.oidc.token.lifespan-grace` Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds. Environment variable: `QUARKUS_OIDC_TOKEN_LIFESPAN_GRACE` Show more	int
`quarkus.oidc.token.age` Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with `quarkus.oidc.token.lifespan-grace` to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (`exp`) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an `exp` claim. However, even if the current logout token is allowed to have no `exp` claim, the `exp` claim is still verified if the logout token contains it. Environment variable: `QUARKUS_OIDC_TOKEN_AGE` Show more	Duration
`quarkus.oidc.token.issued-at-required` Require that the token includes a `iat` (issued at) claim Set this property to `false` if your JWT token does not contain an `iat` (issued at) claim. Note that ID token is always required to have an `iat` claim and therefore this property has no impact on the ID token verification process. Environment variable: `QUARKUS_OIDC_TOKEN_ISSUED_AT_REQUIRED` Show more	boolean	`true`
`quarkus.oidc.token.principal-claim` Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked. Environment variable: `QUARKUS_OIDC_TOKEN_PRINCIPAL_CLAIM` Show more	string
`quarkus.oidc.token.refresh-expired` Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType#WEB_APP`}. This property is enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not need to enable this property manually in this case. Environment variable: `QUARKUS_OIDC_TOKEN_REFRESH_EXPIRED` Show more	boolean	`false`
`quarkus.oidc.token.refresh-token-time-skew` The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token’s expiration time, a refresh is going to happen. Environment variable: `QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW` Show more	Duration
`quarkus.oidc.token.forced-jwk-refresh-interval` The forced JWK set refresh interval in minutes. Environment variable: `QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL` Show more	Duration	`10M`
`quarkus.oidc.token.header` Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType#SERVICE`}. Environment variable: `QUARKUS_OIDC_TOKEN_HEADER` Show more	string
`quarkus.oidc.token.authorization-scheme` HTTP Authorization header scheme. Environment variable: `QUARKUS_OIDC_TOKEN_AUTHORIZATION_SCHEME` Show more	string	`Bearer`
`quarkus.oidc.token.signature-algorithm` Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property. Environment variable: `QUARKUS_OIDC_TOKEN_SIGNATURE_ALGORITHM` Show more	`rs256`, `rs384`, `rs512`, `ps256`, `ps384`, `ps512`, `es256`, `es384`, `es512`, `eddsa`
`quarkus.oidc.token.decryption-key-location` Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the `private_key_jwt` client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens. Environment variable: `QUARKUS_OIDC_TOKEN_DECRYPTION_KEY_LOCATION` Show more	string
`quarkus.oidc.token.allow-jwt-introspection` Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to `true` by default for backward-compatibility reasons. It is planned that this default value will be changed to `false` in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option. Environment variable: `QUARKUS_OIDC_TOKEN_ALLOW_JWT_INTROSPECTION` Show more	boolean	`true`
`quarkus.oidc.token.require-jwt-introspection-only` Require that JWT tokens are only introspected remotely. Environment variable: `QUARKUS_OIDC_TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY` Show more	boolean	`false`
`quarkus.oidc.token.allow-opaque-token-introspection` Allow the remote introspection of the opaque tokens. Set this property to `false` if only JWT tokens are expected. Environment variable: `QUARKUS_OIDC_TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION` Show more	boolean	`true`
`quarkus.oidc.token.customizer-name` Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension. Environment variable: `QUARKUS_OIDC_TOKEN_CUSTOMIZER_NAME` Show more	string
`quarkus.oidc.token.verify-access-token-with-user-info` Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified. Environment variable: `QUARKUS_OIDC_TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO` Show more	boolean	`false`
`quarkus.oidc.logout.path` The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification. Environment variable: `QUARKUS_OIDC_LOGOUT_PATH` Show more	string
`quarkus.oidc.logout.post-logout-path` Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI. Environment variable: `QUARKUS_OIDC_LOGOUT_POST_LOGOUT_PATH` Show more	string
`quarkus.oidc.logout.post-logout-uri-param` Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI. Environment variable: `QUARKUS_OIDC_LOGOUT_POST_LOGOUT_URI_PARAM` Show more	string	`post_logout_redirect_uri`
`quarkus.oidc.logout.extra-params."query-parameter-name"` Additional properties which is added as the query parameters to the logout redirect URI. Environment variable: `QUARKUS_OIDC_LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_` Show more	Map<String,String>
`quarkus.oidc.logout.backchannel.path` The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'. Environment variable: `QUARKUS_OIDC_LOGOUT_BACKCHANNEL_PATH` Show more	string
`quarkus.oidc.logout.backchannel.token-cache-size` Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies. Environment variable: `QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE` Show more	int	`10`
`quarkus.oidc.logout.backchannel.token-cache-time-to-live` Number of minutes a logout token can be cached for. Environment variable: `QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE` Show more	Duration	`10M`
`quarkus.oidc.logout.backchannel.clean-up-timer-interval` Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. Environment variable: `QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL` Show more	Duration
`quarkus.oidc.logout.backchannel.logout-token-key` Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim. Environment variable: `QUARKUS_OIDC_LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY` Show more	string	`sub`
`quarkus.oidc.logout.frontchannel.path` The relative path of the Front-Channel Logout endpoint at the application. Environment variable: `QUARKUS_OIDC_LOGOUT_FRONTCHANNEL_PATH` Show more	string
`quarkus.oidc.certificate-chain.leaf-certificate-name` Common name of the leaf certificate. It must be set if the `trust-store-file` does not have this certificate imported. Environment variable: `QUARKUS_OIDC_CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME` Show more	string
`quarkus.oidc.certificate-chain.trust-store-file` Truststore file which keeps thumbprints of the trusted certificates. Environment variable: `QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE` Show more	path
`quarkus.oidc.certificate-chain.trust-store-password` A parameter to specify the password of the truststore file if it is configured with `trust-store-file`. Environment variable: `QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD` Show more	string
`quarkus.oidc.certificate-chain.trust-store-cert-alias` A parameter to specify the alias of the truststore certificate. Environment variable: `QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS` Show more	string
`quarkus.oidc.certificate-chain.trust-store-file-type` An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name. Environment variable: `QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE` Show more	string
`quarkus.oidc.authentication.response-mode` Authorization code flow response mode. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_RESPONSE_MODE` Show more	`query`Authorization response parameters are encoded in the query string added to the `redirect_uri`, `form-post`Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type	`query`Authorization response parameters are encoded in the query string added to the `redirect_uri`
`quarkus.oidc.authentication.redirect-path` The relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if the current request URI is `https://localhost:8080/service`, a `redirect_uri` parameter is set to `https://localhost:8080/` if this property is set to `/` and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if `restorePathAfterRedirect` is set to `true`. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_REDIRECT_PATH` Show more	string
`quarkus.oidc.authentication.restore-path-after-redirect` If this property is set to `true`, the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI is restored even if this property is disabled. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT` Show more	boolean	`false`
`quarkus.oidc.authentication.remove-redirect-parameters` Remove the query parameters such as `code` and `state` set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS` Show more	boolean	`true`
`quarkus.oidc.authentication.error-path` Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an `error` and an optional `error_description` parameters, instead of the expected authorization `code`. If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if it is set as `/error` and the current request URI is `https://localhost:8080/callback?error=invalid_scope`, a redirect is made to `https://localhost:8080/error?error=invalid_scope`. If this property is not set, HTTP 401 status is returned in case of the user authentication failure. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_ERROR_PATH` Show more	string
`quarkus.oidc.authentication.session-expired-path` Relative path to the public endpoint which an authenticated user is redirected to when the session has expired. When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned. Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH` Show more	string
`quarkus.oidc.authentication.verify-access-token` Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision is based on the roles extracted from the access token. Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to `false` if it is not required. Bearer access token is always verified. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_VERIFY_ACCESS_TOKEN` Show more	boolean	`true when access token is injected as the JsonWebToken bean, false otherwise`
`quarkus.oidc.authentication.force-redirect-https-scheme` Force `https` as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout `post_logout_redirect_uri` and the local redirect requests. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME` Show more	boolean	`false`
`quarkus.oidc.authentication.scopes` List of scopes Environment variable: `QUARKUS_OIDC_AUTHENTICATION_SCOPES` Show more	list of string
`quarkus.oidc.authentication.scope-separator` The separator which is used when more than one scope is configured. A single space is used by default. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_SCOPE_SEPARATOR` Show more	string
`quarkus.oidc.authentication.nonce-required` Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_NONCE_REQUIRED` Show more	boolean	`false`
`quarkus.oidc.authentication.add-openid-scope` Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_ADD_OPENID_SCOPE` Show more	boolean	`true`
`quarkus.oidc.authentication.extra-params."parameter-name"` Additional properties added as query parameters to the authentication redirect URI. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_` Show more	Map<String,String>
`quarkus.oidc.authentication.forward-params` Request URL query parameters which, if present, are added to the authentication redirect URI. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_FORWARD_PARAMS` Show more	list of string
`quarkus.oidc.authentication.cookie-force-secure` If enabled the state, session, and post logout cookies have their `secure` parameter set to `true` when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_COOKIE_FORCE_SECURE` Show more	boolean	`false`
`quarkus.oidc.authentication.cookie-suffix` Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_COOKIE_SUFFIX` Show more	string
`quarkus.oidc.authentication.cookie-path` Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, is checked first. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH` Show more	string	`/`
`quarkus.oidc.authentication.cookie-path-header` Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the `cookie-path` property is checked. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH_HEADER` Show more	string
`quarkus.oidc.authentication.cookie-domain` Cookie domain parameter value which, if set, is used for the session, state and post logout cookies. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_COOKIE_DOMAIN` Show more	string
`quarkus.oidc.authentication.cookie-same-site` SameSite attribute for the session cookie. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_COOKIE_SAME_SITE` Show more	`strict`, `lax`, `none`	`lax`
`quarkus.oidc.authentication.allow-multiple-code-flows` If a state cookie is present, a `state` query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS` Show more	boolean	`true`
`quarkus.oidc.authentication.fail-on-missing-state-param` Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present. When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter. Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` might be needed to avoid such errors. However, setting this property to `false` might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM` Show more	boolean	`false`
`quarkus.oidc.authentication.user-info-required` If this property is set to `true`, an OIDC UserInfo endpoint is called. This property is enabled automatically if `quarkus.oidc.roles.source` is set to `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is set to `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, the current OIDC tenant must support a UserInfo endpoint in these cases. It is also enabled automatically if `io.quarkus.oidc.UserInfo` injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_USER_INFO_REQUIRED` Show more	boolean	`true when UserInfo bean is injected, false otherwise`
`quarkus.oidc.authentication.session-age-extension` Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the `token.refresh-expired` property has not been enabled. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION` Show more	Duration	`5M`
`quarkus.oidc.authentication.state-cookie-age` State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see `allow-multiple-code-flows`. Keep its age to the reasonable minimum value such as 5 minutes or less. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE` Show more	Duration	`5M`
`quarkus.oidc.authentication.java-script-auto-redirect` If this property is set to `true`, a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS. If this property is set to `false`, a status code of `499` is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. `X-Requested-With` request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT` Show more	boolean	`true`
`quarkus.oidc.authentication.id-token-required` Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_ID_TOKEN_REQUIRED` Show more	boolean	`true`
`quarkus.oidc.authentication.internal-id-token-lifespan` Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN` Show more	Duration	`5M`
`quarkus.oidc.authentication.pkce-required` Requires that a Proof Key for Code Exchange (PKCE) is used. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_PKCE_REQUIRED` Show more	boolean	`false`
`quarkus.oidc.authentication.state-secret` Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long. If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. A client secret is not be used as a state encryption secret if it is less than 32 characters long. The secret is auto-generated if it remains uninitialized after checking all of these properties. Error is reported if the secret length is less than 16 characters. Environment variable: `QUARKUS_OIDC_AUTHENTICATION_STATE_SECRET` Show more	string
`quarkus.oidc.code-grant.extra-params."parameter-name"` Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which must be included to complete the authorization code grant request. Environment variable: `QUARKUS_OIDC_CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_` Show more	Map<String,String>
`quarkus.oidc.code-grant.headers."header-name"` Custom HTTP headers which must be sent to complete the authorization code grant request. Environment variable: `QUARKUS_OIDC_CODE_GRANT_HEADERS__HEADER_NAME_` Show more	Map<String,String>
`quarkus.oidc.token-state-manager.strategy` Default TokenStateManager strategy. Environment variable: `QUARKUS_OIDC_TOKEN_STATE_MANAGER_STRATEGY` Show more	`keep-all-tokens`Keep ID, access and refresh tokens., `id-token`Keep ID token only, `id-refresh-tokens`Keep ID and refresh tokens only	`keep-all-tokens`Keep ID, access and refresh tokens.
`quarkus.oidc.token-state-manager.split-tokens` Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size Environment variable: `QUARKUS_OIDC_TOKEN_STATE_MANAGER_SPLIT_TOKENS` Show more	boolean	`false`
`quarkus.oidc.token-state-manager.encryption-required` Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens. Environment variable: `QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED` Show more	boolean	`true`
`quarkus.oidc.token-state-manager.encryption-secret` The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled. If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required. The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters. Environment variable: `QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_SECRET` Show more	string
`quarkus.oidc.token-state-manager.encryption-algorithm` Session cookie key encryption algorithm Environment variable: `QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM` Show more	`a256-gcmkw`Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content., `dir`The configured key encryption secret will be used as the content encryption key to encrypt the session cookie content. Using the direct encryption avoids a content encryption key generation step and will make the encrypted session cookie sequence slightly shorter. Avoid using the direct encryption if the encryption secret is less than 32 characters long.	`a256-gcmkw`Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content.
`quarkus.oidc.allow-token-introspection-cache` Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. Environment variable: `QUARKUS_OIDC_ALLOW_TOKEN_INTROSPECTION_CACHE` Show more	boolean	`true`
`quarkus.oidc.allow-user-info-cache` Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. Environment variable: `QUARKUS_OIDC_ALLOW_USER_INFO_CACHE` Show more	boolean	`true`
`quarkus.oidc.cache-user-info-in-idtoken` Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state. Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the `allow-user-info-cache` property set to `false`. Environment variable: `QUARKUS_OIDC_CACHE_USER_INFO_IN_IDTOKEN` Show more	boolean
`quarkus.oidc.jwks.resolve-early` If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. Environment variable: `QUARKUS_OIDC_JWKS_RESOLVE_EARLY` Show more	boolean	`true`
`quarkus.oidc.jwks.cache-size` Maximum number of JWK keys that can be cached. This property is ignored if the `resolve-early` property is set to true. Environment variable: `QUARKUS_OIDC_JWKS_CACHE_SIZE` Show more	int	`10`
`quarkus.oidc.jwks.cache-time-to-live` Number of minutes a JWK key can be cached for. This property is ignored if the `resolve-early` property is set to true. Environment variable: `QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE` Show more	Duration	`10M`
`quarkus.oidc.jwks.clean-up-timer-interval` Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the `resolve-early` property is set to true. Environment variable: `QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL` Show more	Duration
`quarkus.oidc.jwks.try-all` In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. Environment variable: `QUARKUS_OIDC_JWKS_TRY_ALL` Show more	boolean	`false`
`quarkus.oidc.provider` Well known OpenId Connect provider identifier Environment variable: `QUARKUS_OIDC_PROVIDER` Show more	`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
`quarkus.oidc.token-cache.max-size` Maximum number of cache entries. Set it to a positive value if the cache has to be enabled. Environment variable: `QUARKUS_OIDC_TOKEN_CACHE_MAX_SIZE` Show more	int	`0`
`quarkus.oidc.token-cache.time-to-live` Maximum amount of time a given cache entry is valid for. Environment variable: `QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE` Show more	Duration	`3M`
`quarkus.oidc.token-cache.clean-up-timer-interval` Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically. Environment variable: `QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL` Show more	Duration
`quarkus.oidc.resolve-tenants-with-issuer` If OIDC tenants should be resolved using the bearer access token’s issuer (`iss`) claim value. Environment variable: `QUARKUS_OIDC_RESOLVE_TENANTS_WITH_ISSUER` Show more	boolean	`false`
Additional named tenants	Type	Default
`quarkus.oidc."tenant".auth-server-url` The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/{realm}`, replacing `{realm}` with the Keycloak realm name. Environment variable: `QUARKUS_OIDC__TENANT__AUTH_SERVER_URL` Show more	string
`quarkus.oidc."tenant".discovery-enabled` Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. Environment variable: `QUARKUS_OIDC__TENANT__DISCOVERY_ENABLED` Show more	boolean	`true`
`quarkus.oidc."tenant".registration-path` The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. Environment variable: `QUARKUS_OIDC__TENANT__REGISTRATION_PATH` Show more	string
`quarkus.oidc."tenant".connection-delay` The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. Environment variable: `QUARKUS_OIDC__TENANT__CONNECTION_DELAY` Show more	Duration
`quarkus.oidc."tenant".connection-retry-count` The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. Environment variable: `QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT` Show more	int	`3`
`quarkus.oidc."tenant".connection-timeout` The number of seconds after which the current OIDC connection request times out. Environment variable: `QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT` Show more	Duration	`10S`
`quarkus.oidc."tenant".use-blocking-dns-lookup` Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. Environment variable: `QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP` Show more	boolean	`false`
`quarkus.oidc."tenant".max-pool-size` The maximum size of the connection pool used by the WebClient. Environment variable: `QUARKUS_OIDC__TENANT__MAX_POOL_SIZE` Show more	int
`quarkus.oidc."tenant".proxy.host` The host name or IP address of the Proxy. Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. Environment variable: `QUARKUS_OIDC__TENANT__PROXY_HOST` Show more	string
`quarkus.oidc."tenant".proxy.port` The port number of the Proxy. The default value is `80`. Environment variable: `QUARKUS_OIDC__TENANT__PROXY_PORT` Show more	int	`80`
`quarkus.oidc."tenant".proxy.username` The username, if the Proxy needs authentication. Environment variable: `QUARKUS_OIDC__TENANT__PROXY_USERNAME` Show more	string
`quarkus.oidc."tenant".proxy.password` The password, if the Proxy needs authentication. Environment variable: `QUARKUS_OIDC__TENANT__PROXY_PASSWORD` Show more	string
`quarkus.oidc."tenant".tls.tls-configuration-name` The name of the TLS configuration to use. If a name is configured, it uses the configuration from `quarkus.tls.<name>.` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. The default TLS configuration is not* used by default. Environment variable: `QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME` Show more	string
`quarkus.oidc."tenant".token-path` The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_PATH` Show more	string
`quarkus.oidc."tenant".revoke-path` The relative path or absolute URL of the OIDC token revocation endpoint. Environment variable: `QUARKUS_OIDC__TENANT__REVOKE_PATH` Show more	string
`quarkus.oidc."tenant".client-id` The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. Environment variable: `QUARKUS_OIDC__TENANT__CLIENT_ID` Show more	string
`quarkus.oidc."tenant".client-name` The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider’s dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. Environment variable: `QUARKUS_OIDC__TENANT__CLIENT_NAME` Show more	string
`quarkus.oidc."tenant".credentials.secret` The client secret used by the `client_secret_basic` authentication method. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. You can use `client-secret.value` instead, but both properties are mutually exclusive. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_SECRET` Show more	string
`quarkus.oidc."tenant".credentials.client-secret.value` The client secret value. This value is ignored if `credentials.secret` is set. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_VALUE` Show more	string
`quarkus.oidc."tenant".credentials.client-secret.provider.name` The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME` Show more	string
`quarkus.oidc."tenant".credentials.client-secret.provider.keyring-name` The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME` Show more	string
`quarkus.oidc."tenant".credentials.client-secret.provider.key` The CredentialsProvider client secret key Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY` Show more	string
`quarkus.oidc."tenant".credentials.client-secret.method` The authentication method. If the `clientSecret.value` secret is set, this method is `basic` by default. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_METHOD` Show more	`basicclient_secret_basic` (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme., `postclient_secret_post`\: The client id and secret are submitted as the `client_id` and `client_secret` form parameters., `post-jwtclient_secret_jwt`\: The client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters., `query`client id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.
`quarkus.oidc."tenant".credentials.jwt.source` JWT token source: OIDC provider client or an existing JWT bearer token. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SOURCE` Show more	`client`, `bearer`	`client`
`quarkus.oidc."tenant".credentials.jwt.secret` If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET` Show more	string
`quarkus.oidc."tenant".credentials.jwt.secret-provider.name` The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_NAME` Show more	string
`quarkus.oidc."tenant".credentials.jwt.secret-provider.keyring-name` The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME` Show more	string
`quarkus.oidc."tenant".credentials.jwt.secret-provider.key` The CredentialsProvider client secret key Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEY` Show more	string
`quarkus.oidc."tenant".credentials.jwt.key` String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY` Show more	string
`quarkus.oidc."tenant".credentials.jwt.key-file` If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_FILE` Show more	string
`quarkus.oidc."tenant".credentials.jwt.key-store-file` If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_FILE` Show more	string
`quarkus.oidc."tenant".credentials.jwt.key-store-password` A parameter to specify the password of the keystore file. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_PASSWORD` Show more	string
`quarkus.oidc."tenant".credentials.jwt.key-id` The private key id or alias. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_ID` Show more	string
`quarkus.oidc."tenant".credentials.jwt.key-password` The private key password. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_PASSWORD` Show more	string
`quarkus.oidc."tenant".credentials.jwt.audience` The JWT audience (`aud`) claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_AUDIENCE` Show more	string
`quarkus.oidc."tenant".credentials.jwt.token-key-id` The key identifier of the signing key added as a JWT `kid` header. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_TOKEN_KEY_ID` Show more	string
`quarkus.oidc."tenant".credentials.jwt.issuer` The issuer of the signing key added as a JWT `iss` claim. The default value is the client id. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ISSUER` Show more	string
`quarkus.oidc."tenant".credentials.jwt.subject` Subject of the signing key added as a JWT `sub` claim The default value is the client id. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SUBJECT` Show more	string
`quarkus.oidc."tenant".credentials.jwt.claims."claim-name"` Additional claims. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_` Show more	Map<String,String>
`quarkus.oidc."tenant".credentials.jwt.signature-algorithm` The signature algorithm used for the `key-file` property. Supported values: `RS256` (default), `RS384`, `RS512`, `PS256`, `PS384`, `PS512`, `ES256`, `ES384`, `ES512`, `HS256`, `HS384`, `HS512`. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SIGNATURE_ALGORITHM` Show more	string
`quarkus.oidc."tenant".credentials.jwt.lifespan` The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_LIFESPAN` Show more	int	`10`
`quarkus.oidc."tenant".credentials.jwt.assertion` If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension. Environment variable: `QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ASSERTION` Show more	boolean	`false`
`quarkus.oidc."tenant".tenant-id` A unique tenant identifier. It can be set by `TenantConfigResolver` providers, which resolve the tenant configuration dynamically. Environment variable: `QUARKUS_OIDC__TENANT__TENANT_ID` Show more	string
`quarkus.oidc."tenant".tenant-enabled` If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a `TenantConfigResolver` that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant. Environment variable: `QUARKUS_OIDC__TENANT__TENANT_ENABLED` Show more	boolean	`true`
`quarkus.oidc."tenant".application-type` The application type, which can be one of the following `ApplicationType` values. Environment variable: `QUARKUS_OIDC__TENANT__APPLICATION_TYPE` Show more	`web-app`A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users., `service`A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users., `hybrid`A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.	`service`A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.
`quarkus.oidc."tenant".authorization-path` The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for `web-app` applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled. Environment variable: `QUARKUS_OIDC__TENANT__AUTHORIZATION_PATH` Show more	string
`quarkus.oidc."tenant".user-info-path` The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for `web-app` applications if OIDC discovery is disabled and the `authentication.user-info-required` property is enabled. This property is ignored if OIDC discovery is enabled. Environment variable: `QUARKUS_OIDC__TENANT__USER_INFO_PATH` Show more	string
`quarkus.oidc."tenant".introspection-path` Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled. Environment variable: `QUARKUS_OIDC__TENANT__INTROSPECTION_PATH` Show more	string
`quarkus.oidc."tenant".jwks-path` Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled. Environment variable: `QUARKUS_OIDC__TENANT__JWKS_PATH` Show more	string
`quarkus.oidc."tenant".end-session-path` Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the `web-app` applications is required. This property is ignored if the discovery is enabled. Environment variable: `QUARKUS_OIDC__TENANT__END_SESSION_PATH` Show more	string
`quarkus.oidc."tenant".tenant-paths` The paths which must be secured by this tenant. Tenant with the most specific path wins. Please see the Configure tenant paths section of the OIDC multitenancy guide for explanation of allowed path patterns. Environment variable: `QUARKUS_OIDC__TENANT__TENANT_PATHS` Show more	list of string
`quarkus.oidc."tenant".public-key` The public key for the local JWT token verification. OIDC server connection is not created when this property is set. Environment variable: `QUARKUS_OIDC__TENANT__PUBLIC_KEY` Show more	string
`quarkus.oidc."tenant".introspection-credentials.name` Name Environment variable: `QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_NAME` Show more	string
`quarkus.oidc."tenant".introspection-credentials.secret` Secret Environment variable: `QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_SECRET` Show more	string
`quarkus.oidc."tenant".introspection-credentials.include-client-id` Include OpenId Connect Client ID configured with `quarkus.oidc.client-id`. Environment variable: `QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID` Show more	boolean	`true`
`quarkus.oidc."tenant".roles.role-claim-path` A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no `groups` claim but has the groups set in one or more different claims. Environment variable: `QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_PATH` Show more	list of string
`quarkus.oidc."tenant".roles.role-claim-separator` The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard `scope` claim can contain a space-separated sequence. Environment variable: `QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_SEPARATOR` Show more	string
`quarkus.oidc."tenant".roles.source` Source of the principal roles. Environment variable: `QUARKUS_OIDC__TENANT__ROLES_SOURCE` Show more	`idtoken`ID Token - the default value for the `web-app` applications., `accesstoken`Access Token - the default value for the `service` applications; can also be used as the source of roles for the `web-app` applications., `userinfo`User Info
`quarkus.oidc."tenant".token.issuer` The expected issuer `iss` claim value. This property overrides the `issuer` property, which might be set in OpenId Connect provider’s well-known configuration. If the `iss` claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to `any`, but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_ISSUER` Show more	string
`quarkus.oidc."tenant".token.audience` The expected audience `aud` claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_AUDIENCE` Show more	list of string
`quarkus.oidc."tenant".token.subject-required` Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo `sub` claims must be present and match each other. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_SUBJECT_REQUIRED` Show more	boolean	`false`
`quarkus.oidc."tenant".token.required-claims."claim-name"` A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_` Show more	Map<String,String>
`quarkus.oidc."tenant".token.token-type` Expected token type Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_TOKEN_TYPE` Show more	string
`quarkus.oidc."tenant".token.lifespan-grace` Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_LIFESPAN_GRACE` Show more	int
`quarkus.oidc."tenant".token.age` Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with `quarkus.oidc.token.lifespan-grace` to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (`exp`) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an `exp` claim. However, even if the current logout token is allowed to have no `exp` claim, the `exp` claim is still verified if the logout token contains it. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_AGE` Show more	Duration
`quarkus.oidc."tenant".token.issued-at-required` Require that the token includes a `iat` (issued at) claim Set this property to `false` if your JWT token does not contain an `iat` (issued at) claim. Note that ID token is always required to have an `iat` claim and therefore this property has no impact on the ID token verification process. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_ISSUED_AT_REQUIRED` Show more	boolean	`true`
`quarkus.oidc."tenant".token.principal-claim` Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_PRINCIPAL_CLAIM` Show more	string
`quarkus.oidc."tenant".token.refresh-expired` Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType#WEB_APP`}. This property is enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not need to enable this property manually in this case. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_REFRESH_EXPIRED` Show more	boolean	`false`
`quarkus.oidc."tenant".token.refresh-token-time-skew` The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token’s expiration time, a refresh is going to happen. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW` Show more	Duration
`quarkus.oidc."tenant".token.forced-jwk-refresh-interval` The forced JWK set refresh interval in minutes. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL` Show more	Duration	`10M`
`quarkus.oidc."tenant".token.header` Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType#SERVICE`}. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_HEADER` Show more	string
`quarkus.oidc."tenant".token.authorization-scheme` HTTP Authorization header scheme. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_AUTHORIZATION_SCHEME` Show more	string	`Bearer`
`quarkus.oidc."tenant".token.signature-algorithm` Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_SIGNATURE_ALGORITHM` Show more	`rs256`, `rs384`, `rs512`, `ps256`, `ps384`, `ps512`, `es256`, `es384`, `es512`, `eddsa`
`quarkus.oidc."tenant".token.decryption-key-location` Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the `private_key_jwt` client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_DECRYPTION_KEY_LOCATION` Show more	string
`quarkus.oidc."tenant".token.allow-jwt-introspection` Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to `true` by default for backward-compatibility reasons. It is planned that this default value will be changed to `false` in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_ALLOW_JWT_INTROSPECTION` Show more	boolean	`true`
`quarkus.oidc."tenant".token.require-jwt-introspection-only` Require that JWT tokens are only introspected remotely. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY` Show more	boolean	`false`
`quarkus.oidc."tenant".token.allow-opaque-token-introspection` Allow the remote introspection of the opaque tokens. Set this property to `false` if only JWT tokens are expected. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION` Show more	boolean	`true`
`quarkus.oidc."tenant".token.customizer-name` Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_CUSTOMIZER_NAME` Show more	string
`quarkus.oidc."tenant".token.verify-access-token-with-user-info` Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO` Show more	boolean	`false`
`quarkus.oidc."tenant".logout.path` The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_PATH` Show more	string
`quarkus.oidc."tenant".logout.post-logout-path` Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_PATH` Show more	string
`quarkus.oidc."tenant".logout.post-logout-uri-param` Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_URI_PARAM` Show more	string	`post_logout_redirect_uri`
`quarkus.oidc."tenant".logout.extra-params."query-parameter-name"` Additional properties which is added as the query parameters to the logout redirect URI. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_` Show more	Map<String,String>
`quarkus.oidc."tenant".logout.backchannel.path` The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_PATH` Show more	string
`quarkus.oidc."tenant".logout.backchannel.token-cache-size` Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE` Show more	int	`10`
`quarkus.oidc."tenant".logout.backchannel.token-cache-time-to-live` Number of minutes a logout token can be cached for. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE` Show more	Duration	`10M`
`quarkus.oidc."tenant".logout.backchannel.clean-up-timer-interval` Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL` Show more	Duration
`quarkus.oidc."tenant".logout.backchannel.logout-token-key` Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY` Show more	string	`sub`
`quarkus.oidc."tenant".logout.frontchannel.path` The relative path of the Front-Channel Logout endpoint at the application. Environment variable: `QUARKUS_OIDC__TENANT__LOGOUT_FRONTCHANNEL_PATH` Show more	string
`quarkus.oidc."tenant".certificate-chain.leaf-certificate-name` Common name of the leaf certificate. It must be set if the `trust-store-file` does not have this certificate imported. Environment variable: `QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME` Show more	string
`quarkus.oidc."tenant".certificate-chain.trust-store-file` Truststore file which keeps thumbprints of the trusted certificates. Environment variable: `QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE` Show more	path
`quarkus.oidc."tenant".certificate-chain.trust-store-password` A parameter to specify the password of the truststore file if it is configured with `trust-store-file`. Environment variable: `QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD` Show more	string
`quarkus.oidc."tenant".certificate-chain.trust-store-cert-alias` A parameter to specify the alias of the truststore certificate. Environment variable: `QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS` Show more	string
`quarkus.oidc."tenant".certificate-chain.trust-store-file-type` An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name. Environment variable: `QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE` Show more	string
`quarkus.oidc."tenant".authentication.response-mode` Authorization code flow response mode. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_RESPONSE_MODE` Show more	`query`Authorization response parameters are encoded in the query string added to the `redirect_uri`, `form-post`Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type	`query`Authorization response parameters are encoded in the query string added to the `redirect_uri`
`quarkus.oidc."tenant".authentication.redirect-path` The relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if the current request URI is `https://localhost:8080/service`, a `redirect_uri` parameter is set to `https://localhost:8080/` if this property is set to `/` and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if `restorePathAfterRedirect` is set to `true`. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_REDIRECT_PATH` Show more	string
`quarkus.oidc."tenant".authentication.restore-path-after-redirect` If this property is set to `true`, the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI is restored even if this property is disabled. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT` Show more	boolean	`false`
`quarkus.oidc."tenant".authentication.remove-redirect-parameters` Remove the query parameters such as `code` and `state` set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS` Show more	boolean	`true`
`quarkus.oidc."tenant".authentication.error-path` Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an `error` and an optional `error_description` parameters, instead of the expected authorization `code`. If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if it is set as `/error` and the current request URI is `https://localhost:8080/callback?error=invalid_scope`, a redirect is made to `https://localhost:8080/error?error=invalid_scope`. If this property is not set, HTTP 401 status is returned in case of the user authentication failure. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_ERROR_PATH` Show more	string
`quarkus.oidc."tenant".authentication.session-expired-path` Relative path to the public endpoint which an authenticated user is redirected to when the session has expired. When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned. Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH` Show more	string
`quarkus.oidc."tenant".authentication.verify-access-token` Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision is based on the roles extracted from the access token. Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to `false` if it is not required. Bearer access token is always verified. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_VERIFY_ACCESS_TOKEN` Show more	boolean	`true when access token is injected as the JsonWebToken bean, false otherwise`
`quarkus.oidc."tenant".authentication.force-redirect-https-scheme` Force `https` as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout `post_logout_redirect_uri` and the local redirect requests. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME` Show more	boolean	`false`
`quarkus.oidc."tenant".authentication.scopes` List of scopes Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPES` Show more	list of string
`quarkus.oidc."tenant".authentication.scope-separator` The separator which is used when more than one scope is configured. A single space is used by default. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPE_SEPARATOR` Show more	string
`quarkus.oidc."tenant".authentication.nonce-required` Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_NONCE_REQUIRED` Show more	boolean	`false`
`quarkus.oidc."tenant".authentication.add-openid-scope` Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_ADD_OPENID_SCOPE` Show more	boolean	`true`
`quarkus.oidc."tenant".authentication.extra-params."parameter-name"` Additional properties added as query parameters to the authentication redirect URI. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_` Show more	Map<String,String>
`quarkus.oidc."tenant".authentication.forward-params` Request URL query parameters which, if present, are added to the authentication redirect URI. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_FORWARD_PARAMS` Show more	list of string
`quarkus.oidc."tenant".authentication.cookie-force-secure` If enabled the state, session, and post logout cookies have their `secure` parameter set to `true` when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_FORCE_SECURE` Show more	boolean	`false`
`quarkus.oidc."tenant".authentication.cookie-suffix` Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SUFFIX` Show more	string
`quarkus.oidc."tenant".authentication.cookie-path` Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, is checked first. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH` Show more	string	`/`
`quarkus.oidc."tenant".authentication.cookie-path-header` Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the `cookie-path` property is checked. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH_HEADER` Show more	string
`quarkus.oidc."tenant".authentication.cookie-domain` Cookie domain parameter value which, if set, is used for the session, state and post logout cookies. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_DOMAIN` Show more	string
`quarkus.oidc."tenant".authentication.cookie-same-site` SameSite attribute for the session cookie. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SAME_SITE` Show more	`strict`, `lax`, `none`	`lax`
`quarkus.oidc."tenant".authentication.allow-multiple-code-flows` If a state cookie is present, a `state` query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS` Show more	boolean	`true`
`quarkus.oidc."tenant".authentication.fail-on-missing-state-param` Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present. When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter. Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` might be needed to avoid such errors. However, setting this property to `false` might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM` Show more	boolean	`false`
`quarkus.oidc."tenant".authentication.user-info-required` If this property is set to `true`, an OIDC UserInfo endpoint is called. This property is enabled automatically if `quarkus.oidc.roles.source` is set to `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is set to `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, the current OIDC tenant must support a UserInfo endpoint in these cases. It is also enabled automatically if `io.quarkus.oidc.UserInfo` injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_USER_INFO_REQUIRED` Show more	boolean	`true when UserInfo bean is injected, false otherwise`
`quarkus.oidc."tenant".authentication.session-age-extension` Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the `token.refresh-expired` property has not been enabled. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION` Show more	Duration	`5M`
`quarkus.oidc."tenant".authentication.state-cookie-age` State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see `allow-multiple-code-flows`. Keep its age to the reasonable minimum value such as 5 minutes or less. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE` Show more	Duration	`5M`
`quarkus.oidc."tenant".authentication.java-script-auto-redirect` If this property is set to `true`, a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS. If this property is set to `false`, a status code of `499` is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. `X-Requested-With` request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT` Show more	boolean	`true`
`quarkus.oidc."tenant".authentication.id-token-required` Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_ID_TOKEN_REQUIRED` Show more	boolean	`true`
`quarkus.oidc."tenant".authentication.internal-id-token-lifespan` Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN` Show more	Duration	`5M`
`quarkus.oidc."tenant".authentication.pkce-required` Requires that a Proof Key for Code Exchange (PKCE) is used. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_PKCE_REQUIRED` Show more	boolean	`false`
`quarkus.oidc."tenant".authentication.state-secret` Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long. If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. A client secret is not be used as a state encryption secret if it is less than 32 characters long. The secret is auto-generated if it remains uninitialized after checking all of these properties. Error is reported if the secret length is less than 16 characters. Environment variable: `QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_SECRET` Show more	string
`quarkus.oidc."tenant".code-grant.extra-params."parameter-name"` Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which must be included to complete the authorization code grant request. Environment variable: `QUARKUS_OIDC__TENANT__CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_` Show more	Map<String,String>
`quarkus.oidc."tenant".code-grant.headers."header-name"` Custom HTTP headers which must be sent to complete the authorization code grant request. Environment variable: `QUARKUS_OIDC__TENANT__CODE_GRANT_HEADERS__HEADER_NAME_` Show more	Map<String,String>
`quarkus.oidc."tenant".token-state-manager.strategy` Default TokenStateManager strategy. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_STRATEGY` Show more	`keep-all-tokens`Keep ID, access and refresh tokens., `id-token`Keep ID token only, `id-refresh-tokens`Keep ID and refresh tokens only	`keep-all-tokens`Keep ID, access and refresh tokens.
`quarkus.oidc."tenant".token-state-manager.split-tokens` Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_SPLIT_TOKENS` Show more	boolean	`false`
`quarkus.oidc."tenant".token-state-manager.encryption-required` Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED` Show more	boolean	`true`
`quarkus.oidc."tenant".token-state-manager.encryption-secret` The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled. If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required. The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters. Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_SECRET` Show more	string
`quarkus.oidc."tenant".token-state-manager.encryption-algorithm` Session cookie key encryption algorithm Environment variable: `QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM` Show more	`a256-gcmkw`Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content., `dir`The configured key encryption secret will be used as the content encryption key to encrypt the session cookie content. Using the direct encryption avoids a content encryption key generation step and will make the encrypted session cookie sequence slightly shorter. Avoid using the direct encryption if the encryption secret is less than 32 characters long.	`a256-gcmkw`Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content.
`quarkus.oidc."tenant".allow-token-introspection-cache` Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. Environment variable: `QUARKUS_OIDC__TENANT__ALLOW_TOKEN_INTROSPECTION_CACHE` Show more	boolean	`true`
`quarkus.oidc."tenant".allow-user-info-cache` Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. Environment variable: `QUARKUS_OIDC__TENANT__ALLOW_USER_INFO_CACHE` Show more	boolean	`true`
`quarkus.oidc."tenant".cache-user-info-in-idtoken` Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state. Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the `allow-user-info-cache` property set to `false`. Environment variable: `QUARKUS_OIDC__TENANT__CACHE_USER_INFO_IN_IDTOKEN` Show more	boolean
`quarkus.oidc."tenant".jwks.resolve-early` If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. Environment variable: `QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY` Show more	boolean	`true`
`quarkus.oidc."tenant".jwks.cache-size` Maximum number of JWK keys that can be cached. This property is ignored if the `resolve-early` property is set to true. Environment variable: `QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE` Show more	int	`10`
`quarkus.oidc."tenant".jwks.cache-time-to-live` Number of minutes a JWK key can be cached for. This property is ignored if the `resolve-early` property is set to true. Environment variable: `QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE` Show more	Duration	`10M`
`quarkus.oidc."tenant".jwks.clean-up-timer-interval` Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the `resolve-early` property is set to true. Environment variable: `QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL` Show more	Duration
`quarkus.oidc."tenant".jwks.try-all` In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. Environment variable: `QUARKUS_OIDC__TENANT__JWKS_TRY_ALL` Show more	boolean	`false`
`quarkus.oidc."tenant".provider` Well known OpenId Connect provider identifier Environment variable: `QUARKUS_OIDC__TENANT__PROVIDER` Show more	`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`

Configuration property

Type

Default

quarkus.oidc.enabled

If the OIDC extension is enabled.

Environment variable: QUARKUS_OIDC_ENABLED

boolean

true

quarkus.oidc.devui.grant.type

Grant type which will be used to acquire a token to test the OIDC 'service' applications

Environment variable: QUARKUS_OIDC_DEVUI_GRANT_TYPE

client'client_credentials' grant, password'password' grant, code'authorization_code' grant, implicit'implicit' grant

quarkus.oidc.devui.grant-options."option-name"

Grant options

Environment variable: QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_

Map<String,Map<String,String>>

quarkus.oidc.devui.web-client-timeout

The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint.

Environment variable: QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT

Duration

4S

quarkus.oidc.default-token-cache-enabled

Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note: This only enables the default implementation. It requires configuration to be activated. See OidcConfig#tokenCache.

Environment variable: QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED

boolean

true

quarkus.oidc.auth-server-url

The base URL of the OpenID Connect (OIDC) server, for example, https://host:port/auth. Do not set this property if you use 'quarkus-oidc' and the public key verification (public-key) or certificate chain verification only (certificate-chain) is required. The OIDC discovery endpoint is called by default by appending a .well-known/openid-configuration path to this URL. For Keycloak, use https://host:port/realms/{realm}, replacing {realm} with the Keycloak realm name.

Environment variable: QUARKUS_OIDC_AUTH_SERVER_URL

string

quarkus.oidc.discovery-enabled

Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.

Environment variable: QUARKUS_OIDC_DISCOVERY_ENABLED

boolean

true

quarkus.oidc.registration-path

The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if discovery-enabled is false or a discovered token endpoint path must be customized.

Environment variable: QUARKUS_OIDC_REGISTRATION_PATH

string

quarkus.oidc.connection-delay

The duration to attempt the initial connection to an OIDC server. For example, setting the duration to 20S allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the connection-retry-count property instead.

Environment variable: QUARKUS_OIDC_CONNECTION_DELAY

Duration

quarkus.oidc.connection-retry-count

The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from connection-delay, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting.

Environment variable: QUARKUS_OIDC_CONNECTION_RETRY_COUNT

int

3

quarkus.oidc.connection-timeout

The number of seconds after which the current OIDC connection request times out.

Environment variable: QUARKUS_OIDC_CONNECTION_TIMEOUT

Duration

10S

quarkus.oidc.use-blocking-dns-lookup

Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server.

Environment variable: QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP

boolean

false

quarkus.oidc.max-pool-size

The maximum size of the connection pool used by the WebClient.

Environment variable: QUARKUS_OIDC_MAX_POOL_SIZE

int

quarkus.oidc.proxy.host

The host name or IP address of the Proxy.
Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy.

Environment variable: QUARKUS_OIDC_PROXY_HOST

string

quarkus.oidc.proxy.port

The port number of the Proxy. The default value is 80.

Environment variable: QUARKUS_OIDC_PROXY_PORT

int

80

quarkus.oidc.proxy.username

The username, if the Proxy needs authentication.

Environment variable: QUARKUS_OIDC_PROXY_USERNAME

string

quarkus.oidc.proxy.password

The password, if the Proxy needs authentication.

Environment variable: QUARKUS_OIDC_PROXY_PASSWORD

string

quarkus.oidc.tls.tls-configuration-name

The name of the TLS configuration to use.

If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

The default TLS configuration is not used by default.

Environment variable: QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME

string

quarkus.oidc.token-path

The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if discovery-enabled is false or a discovered token endpoint path must be customized.

Environment variable: QUARKUS_OIDC_TOKEN_PATH

string

quarkus.oidc.revoke-path

The relative path or absolute URL of the OIDC token revocation endpoint.

Environment variable: QUARKUS_OIDC_REVOKE_PATH

string

quarkus.oidc.client-id

The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if application-type is service and no token introspection is required.

Environment variable: QUARKUS_OIDC_CLIENT_ID

string

quarkus.oidc.client-name

The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider’s dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client.

Environment variable: QUARKUS_OIDC_CLIENT_NAME

string

quarkus.oidc.credentials.secret

The client secret used by the client_secret_basic authentication method. Must be set unless a secret is set in client-secret or jwt client authentication is required. You can use client-secret.value instead, but both properties are mutually exclusive.

Environment variable: QUARKUS_OIDC_CREDENTIALS_SECRET

string

quarkus.oidc.credentials.client-secret.value

The client secret value. This value is ignored if credentials.secret is set. Must be set unless a secret is set in client-secret or jwt client authentication is required.

Environment variable: QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE

string

quarkus.oidc.credentials.client-secret.provider.name

The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered

Environment variable: QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME

string

quarkus.oidc.credentials.client-secret.provider.keyring-name

The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager

Environment variable: QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME

string

quarkus.oidc.credentials.client-secret.provider.key

The CredentialsProvider client secret key

Environment variable: QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY

string

quarkus.oidc.credentials.client-secret.method

The authentication method. If the clientSecret.value secret is set, this method is basic by default.

Environment variable: QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD

basicclient_secret_basic (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme., postclient_secret_post\: The client id and secret are submitted as the client_id and client_secret form parameters., post-jwtclient_secret_jwt\: The client id and generated JWT secret are submitted as the client_id and client_secret form parameters., queryclient id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.

quarkus.oidc.credentials.jwt.source

JWT token source: OIDC provider client or an existing JWT bearer token.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE

client, bearer

client

quarkus.oidc.credentials.jwt.secret

If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with key, key-file and key-store properties.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SECRET

string

quarkus.oidc.credentials.jwt.secret-provider.name

The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME

string

quarkus.oidc.credentials.jwt.secret-provider.keyring-name

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME

string

quarkus.oidc.credentials.jwt.secret-provider.key

The CredentialsProvider client secret key

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY

string

quarkus.oidc.credentials.jwt.key

String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with secret, key-file and key-store properties. You can use the signature-algorithm property to override the default key algorithm, RS256.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_KEY

string

quarkus.oidc.credentials.jwt.key-file

If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with secret, key and key-store properties. You can use the signature-algorithm property to override the default key algorithm, RS256.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE

string

quarkus.oidc.credentials.jwt.key-store-file

If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with secret, key and key-file properties.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE

string

quarkus.oidc.credentials.jwt.key-store-password

A parameter to specify the password of the keystore file.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD

string

quarkus.oidc.credentials.jwt.key-id

The private key id or alias.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID

string

quarkus.oidc.credentials.jwt.key-password

The private key password.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD

string

quarkus.oidc.credentials.jwt.audience

The JWT audience (aud) claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE

string

quarkus.oidc.credentials.jwt.token-key-id

The key identifier of the signing key added as a JWT kid header.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID

string

quarkus.oidc.credentials.jwt.issuer

The issuer of the signing key added as a JWT iss claim. The default value is the client id.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER

string

quarkus.oidc.credentials.jwt.subject

Subject of the signing key added as a JWT sub claim The default value is the client id.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT

string

quarkus.oidc.credentials.jwt.claims."claim-name"

Additional claims.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_

Map<String,String>

quarkus.oidc.credentials.jwt.signature-algorithm

The signature algorithm used for the key-file property. Supported values: RS256 (default), RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM

string

quarkus.oidc.credentials.jwt.lifespan

The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN

int

10

quarkus.oidc.credentials.jwt.assertion

If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension.

Environment variable: QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION

boolean

false

quarkus.oidc.tenant-id

A unique tenant identifier. It can be set by TenantConfigResolver providers, which resolve the tenant configuration dynamically.

Environment variable: QUARKUS_OIDC_TENANT_ID

string

quarkus.oidc.tenant-enabled

If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a TenantConfigResolver that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant.

Environment variable: QUARKUS_OIDC_TENANT_ENABLED

boolean

true

quarkus.oidc.application-type

The application type, which can be one of the following ApplicationType values.

Environment variable: QUARKUS_OIDC_APPLICATION_TYPE

web-appA WEB_APP is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users., serviceA SERVICE is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users., hybridA combined SERVICE and WEB_APP client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.

serviceA {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.

quarkus.oidc.authorization-path

The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for web-app applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled.

Environment variable: QUARKUS_OIDC_AUTHORIZATION_PATH

string

quarkus.oidc.user-info-path

The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for web-app applications if OIDC discovery is disabled and the authentication.user-info-required property is enabled. This property is ignored if OIDC discovery is enabled.

Environment variable: QUARKUS_OIDC_USER_INFO_PATH

string

quarkus.oidc.introspection-path

Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled.

Environment variable: QUARKUS_OIDC_INTROSPECTION_PATH

string

quarkus.oidc.jwks-path

Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled.

Environment variable: QUARKUS_OIDC_JWKS_PATH

string

quarkus.oidc.end-session-path

Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the web-app applications is required. This property is ignored if the discovery is enabled.

Environment variable: QUARKUS_OIDC_END_SESSION_PATH

string

quarkus.oidc.tenant-paths

The paths which must be secured by this tenant. Tenant with the most specific path wins. Please see the Configure tenant paths section of the OIDC multitenancy guide for explanation of allowed path patterns.

Environment variable: QUARKUS_OIDC_TENANT_PATHS

list of string

quarkus.oidc.public-key

The public key for the local JWT token verification. OIDC server connection is not created when this property is set.

Environment variable: QUARKUS_OIDC_PUBLIC_KEY

string

quarkus.oidc.introspection-credentials.name

Name

Environment variable: QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_NAME

string

quarkus.oidc.introspection-credentials.secret

Secret

Environment variable: QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_SECRET

string

quarkus.oidc.introspection-credentials.include-client-id

Include OpenId Connect Client ID configured with quarkus.oidc.client-id.

Environment variable: QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID

boolean

true

quarkus.oidc.roles.role-claim-path

A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no groups claim but has the groups set in one or more different claims.

Environment variable: QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH

list of string

quarkus.oidc.roles.role-claim-separator

The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard scope claim can contain a space-separated sequence.

Environment variable: QUARKUS_OIDC_ROLES_ROLE_CLAIM_SEPARATOR

string

quarkus.oidc.roles.source

Source of the principal roles.

Environment variable: QUARKUS_OIDC_ROLES_SOURCE

idtokenID Token - the default value for the web-app applications., accesstokenAccess Token - the default value for the service applications; can also be used as the source of roles for the web-app applications., userinfoUser Info

quarkus.oidc.token.issuer

The expected issuer iss claim value. This property overrides the issuer property, which might be set in OpenId Connect provider’s well-known configuration. If the iss claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to any, but it should be done only when other options (such as configuring the provider to use the fixed iss claim value) are not possible.

Environment variable: QUARKUS_OIDC_TOKEN_ISSUER

string

quarkus.oidc.token.audience

The expected audience aud claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of quarkus.oidc.client-id property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to any if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured.

Environment variable: QUARKUS_OIDC_TOKEN_AUDIENCE

list of string

quarkus.oidc.token.subject-required

Require that the token includes a sub (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo sub claims must be present and match each other.

Environment variable: QUARKUS_OIDC_TOKEN_SUBJECT_REQUIRED

boolean

false

quarkus.oidc.token.required-claims."claim-name"

A map of required claims and their expected values. For example, quarkus.oidc.token.required-claims.org_id = org_xyz would require tokens to have the org_id claim to be present and set to org_xyz. Strings are the only supported types. Use SecurityIdentityAugmentor to verify claims of other types or complex claims.

Environment variable: QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_

Map<String,String>

quarkus.oidc.token.token-type

Expected token type

Environment variable: QUARKUS_OIDC_TOKEN_TOKEN_TYPE

string

quarkus.oidc.token.lifespan-grace

Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.

Environment variable: QUARKUS_OIDC_TOKEN_LIFESPAN_GRACE

int

quarkus.oidc.token.age

Token age. It allows for the number of seconds to be specified that must not elapse since the iat (issued at) time. A small leeway to account for clock skew which can be configured with quarkus.oidc.token.lifespan-grace to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (exp) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an exp claim. However, even if the current logout token is allowed to have no exp claim, the exp claim is still verified if the logout token contains it.

Environment variable: QUARKUS_OIDC_TOKEN_AGE

Duration

quarkus.oidc.token.issued-at-required

Require that the token includes a iat (issued at) claim Set this property to false if your JWT token does not contain an iat (issued at) claim. Note that ID token is always required to have an iat claim and therefore this property has no impact on the ID token verification process.

Environment variable: QUARKUS_OIDC_TOKEN_ISSUED_AT_REQUIRED

boolean

true

quarkus.oidc.token.principal-claim

Name of the claim which contains a principal name. By default, the upn, preferred_username and sub claims are checked.

Environment variable: QUARKUS_OIDC_TOKEN_PRINCIPAL_CLAIM

string

quarkus.oidc.token.refresh-expired

Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the authentication.session-age-extension property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type ApplicationType#WEB_APP}. This property is enabled if quarkus.oidc.token.refresh-token-time-skew is configured, you do not need to enable this property manually in this case.

Environment variable: QUARKUS_OIDC_TOKEN_REFRESH_EXPIRED

boolean

false

quarkus.oidc.token.refresh-token-time-skew

The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token’s expiration time, a refresh is going to happen.

Environment variable: QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW

Duration

quarkus.oidc.token.forced-jwk-refresh-interval

The forced JWK set refresh interval in minutes.

Environment variable: QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL

Duration

10M

quarkus.oidc.token.header

Custom HTTP header that contains a bearer token. This option is valid only when the application is of type ApplicationType#SERVICE}.

Environment variable: QUARKUS_OIDC_TOKEN_HEADER

string

quarkus.oidc.token.authorization-scheme

HTTP Authorization header scheme.

Environment variable: QUARKUS_OIDC_TOKEN_AUTHORIZATION_SCHEME

string

Bearer

quarkus.oidc.token.signature-algorithm

Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.

Environment variable: QUARKUS_OIDC_TOKEN_SIGNATURE_ALGORITHM

rs256, rs384, rs512, ps256, ps384, ps512, es256, es384, es512, eddsa

quarkus.oidc.token.decryption-key-location

Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the private_key_jwt client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens.

Environment variable: QUARKUS_OIDC_TOKEN_DECRYPTION_KEY_LOCATION

string

quarkus.oidc.token.allow-jwt-introspection

Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to true by default for backward-compatibility reasons. It is planned that this default value will be changed to false in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.

Environment variable: QUARKUS_OIDC_TOKEN_ALLOW_JWT_INTROSPECTION

boolean

true

quarkus.oidc.token.require-jwt-introspection-only

Require that JWT tokens are only introspected remotely.

Environment variable: QUARKUS_OIDC_TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY

boolean

false

quarkus.oidc.token.allow-opaque-token-introspection

Allow the remote introspection of the opaque tokens. Set this property to false if only JWT tokens are expected.

Environment variable: QUARKUS_OIDC_TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION

boolean

true

quarkus.oidc.token.customizer-name

Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using TenantFeature qualifier when registering custom TokenCustomizer. Use this property only to refer to TokenCustomizer implementations provided by this extension.

Environment variable: QUARKUS_OIDC_TOKEN_CUSTOMIZER_NAME

string

quarkus.oidc.token.verify-access-token-with-user-info

Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified.

Environment variable: QUARKUS_OIDC_TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO

boolean

false

quarkus.oidc.logout.path

The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.

Environment variable: QUARKUS_OIDC_LOGOUT_PATH

string

quarkus.oidc.logout.post-logout-path

Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.

Environment variable: QUARKUS_OIDC_LOGOUT_POST_LOGOUT_PATH

string

quarkus.oidc.logout.post-logout-uri-param

Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI.

Environment variable: QUARKUS_OIDC_LOGOUT_POST_LOGOUT_URI_PARAM

string

post_logout_redirect_uri

quarkus.oidc.logout.extra-params."query-parameter-name"

Additional properties which is added as the query parameters to the logout redirect URI.

Environment variable: QUARKUS_OIDC_LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_

Map<String,String>

quarkus.oidc.logout.backchannel.path

The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.

Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_PATH

string

quarkus.oidc.logout.backchannel.token-cache-size

Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.

Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE

int

10

quarkus.oidc.logout.backchannel.token-cache-time-to-live

Number of minutes a logout token can be cached for.

Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE

Duration

10M

quarkus.oidc.logout.backchannel.clean-up-timer-interval

Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.

Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL

Duration

quarkus.oidc.logout.backchannel.logout-token-key

Logout token claim whose value is used as a key for caching the tokens. Only sub (subject) and sid (session id) claims can be used as keys. Set it to sid only if ID tokens issued by the OIDC provider have no sub but have sid claim.

Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY

string

sub

quarkus.oidc.logout.frontchannel.path

The relative path of the Front-Channel Logout endpoint at the application.

Environment variable: QUARKUS_OIDC_LOGOUT_FRONTCHANNEL_PATH

string

quarkus.oidc.certificate-chain.leaf-certificate-name

Common name of the leaf certificate. It must be set if the trust-store-file does not have this certificate imported.

Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME

string

quarkus.oidc.certificate-chain.trust-store-file

Truststore file which keeps thumbprints of the trusted certificates.

Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE

path

quarkus.oidc.certificate-chain.trust-store-password

A parameter to specify the password of the truststore file if it is configured with trust-store-file.

Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD

string

quarkus.oidc.certificate-chain.trust-store-cert-alias

A parameter to specify the alias of the truststore certificate.

Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS

string

quarkus.oidc.certificate-chain.trust-store-file-type

An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.

Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE

string

quarkus.oidc.authentication.response-mode

Authorization code flow response mode.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_RESPONSE_MODE

queryAuthorization response parameters are encoded in the query string added to the redirect_uri, form-postAuthorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type

queryAuthorization response parameters are encoded in the query string added to the redirect_uri

quarkus.oidc.authentication.redirect-path

The relative path for calculating a redirect_uri query parameter. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if the current request URI is https://localhost:8080/service, a redirect_uri parameter is set to https://localhost:8080/ if this property is set to / and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if restorePathAfterRedirect is set to true.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_REDIRECT_PATH

string

quarkus.oidc.authentication.restore-path-after-redirect

If this property is set to true, the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if redirectPath property is not set, the original request URI is restored even if this property is disabled.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT

boolean

false

quarkus.oidc.authentication.remove-redirect-parameters

Remove the query parameters such as code and state set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS

boolean

true

quarkus.oidc.authentication.error-path

Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an error and an optional error_description parameters, instead of the expected authorization code. If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if it is set as /error and the current request URI is https://localhost:8080/callback?error=invalid_scope, a redirect is made to https://localhost:8080/error?error=invalid_scope. If this property is not set, HTTP 401 status is returned in case of the user authentication failure.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_ERROR_PATH

string

quarkus.oidc.authentication.session-expired-path

Relative path to the public endpoint which an authenticated user is redirected to when the session has expired.

When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned.

Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH

string

quarkus.oidc.authentication.verify-access-token

Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow.

ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles.

Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless quarkus.oidc.roles.source property is set to accesstoken which means the authorization decision is based on the roles extracted from the access token.

Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to false if it is not required.

Bearer access token is always verified.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_VERIFY_ACCESS_TOKEN

boolean

true when access token is injected as the JsonWebToken bean, false otherwise

quarkus.oidc.authentication.force-redirect-https-scheme

Force https as the redirect_uri parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout post_logout_redirect_uri and the local redirect requests.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME

boolean

false

quarkus.oidc.authentication.scopes

List of scopes

Environment variable: QUARKUS_OIDC_AUTHENTICATION_SCOPES

list of string

quarkus.oidc.authentication.scope-separator

The separator which is used when more than one scope is configured. A single space is used by default.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_SCOPE_SEPARATOR

string

quarkus.oidc.authentication.nonce-required

Require that ID token includes a nonce claim which must match nonce authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting nonce in ID token or if you work with OAuth2 provider such as GitHub which does not issue ID tokens.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_NONCE_REQUIRED

boolean

false

quarkus.oidc.authentication.add-openid-scope

Add the openid scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_ADD_OPENID_SCOPE

boolean

true

quarkus.oidc.authentication.extra-params."parameter-name"

Additional properties added as query parameters to the authentication redirect URI.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_

Map<String,String>

quarkus.oidc.authentication.forward-params

Request URL query parameters which, if present, are added to the authentication redirect URI.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_FORWARD_PARAMS

list of string

quarkus.oidc.authentication.cookie-force-secure

If enabled the state, session, and post logout cookies have their secure parameter set to true when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_FORCE_SECURE

boolean

false

quarkus.oidc.authentication.cookie-suffix

Cookie name suffix. For example, a session cookie name for the default OIDC tenant is q_session but can be changed to q_session_test if this property is set to test.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_SUFFIX

string

quarkus.oidc.authentication.cookie-path

Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The cookie-path-header property, if set, is checked first.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH

string

/

quarkus.oidc.authentication.cookie-path-header

Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the cookie-path property is checked.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH_HEADER

string

quarkus.oidc.authentication.cookie-domain

Cookie domain parameter value which, if set, is used for the session, state and post logout cookies.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_DOMAIN

string

quarkus.oidc.authentication.cookie-same-site

SameSite attribute for the session cookie.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_SAME_SITE

strict, lax, none

lax

quarkus.oidc.authentication.allow-multiple-code-flows

If a state cookie is present, a state query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the state query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS

boolean

true

quarkus.oidc.authentication.fail-on-missing-state-param

Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.

When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter.

Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling java-script-auto-redirect or having the provider redirect to URL configured with redirect-path might be needed to avoid such errors.

However, setting this property to false might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM

boolean

false

quarkus.oidc.authentication.user-info-required

If this property is set to true, an OIDC UserInfo endpoint is called.

This property is enabled automatically if quarkus.oidc.roles.source is set to userinfo or quarkus.oidc.token.verify-access-token-with-user-info is set to true or quarkus.oidc.authentication.id-token-required is set to false, the current OIDC tenant must support a UserInfo endpoint in these cases.

It is also enabled automatically if io.quarkus.oidc.UserInfo injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_USER_INFO_REQUIRED

boolean

true when UserInfo bean is injected, false otherwise

quarkus.oidc.authentication.session-age-extension

Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the token.refresh-expired property has not been enabled.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION

Duration

5M

quarkus.oidc.authentication.state-cookie-age

State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see allow-multiple-code-flows. Keep its age to the reasonable minimum value such as 5 minutes or less.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE

Duration

5M

quarkus.oidc.authentication.java-script-auto-redirect

If this property is set to true, a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS.

If this property is set to false, a status code of 499 is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. X-Requested-With request header with its value set to either JavaScript or XMLHttpRequest is expected by default if this property is enabled. You can register a custom JavaScriptRequestChecker to do a custom JavaScript request check instead.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT

boolean

true

quarkus.oidc.authentication.id-token-required

Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_ID_TOKEN_REQUIRED

boolean

true

quarkus.oidc.authentication.internal-id-token-lifespan

Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN

Duration

5M

quarkus.oidc.authentication.pkce-required

Requires that a Proof Key for Code Exchange (PKCE) is used.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_PKCE_REQUIRED

boolean

false

quarkus.oidc.authentication.state-secret

Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.

The secret is auto-generated if it remains uninitialized after checking all of these properties.

Error is reported if the secret length is less than 16 characters.

Environment variable: QUARKUS_OIDC_AUTHENTICATION_STATE_SECRET

string

quarkus.oidc.code-grant.extra-params."parameter-name"

Additional parameters, in addition to the required code and redirect-uri parameters, which must be included to complete the authorization code grant request.

Environment variable: QUARKUS_OIDC_CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_

Map<String,String>

quarkus.oidc.code-grant.headers."header-name"

Custom HTTP headers which must be sent to complete the authorization code grant request.

Environment variable: QUARKUS_OIDC_CODE_GRANT_HEADERS__HEADER_NAME_

Map<String,String>

quarkus.oidc.token-state-manager.strategy

Default TokenStateManager strategy.

Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_STRATEGY

keep-all-tokensKeep ID, access and refresh tokens., id-tokenKeep ID token only, id-refresh-tokensKeep ID and refresh tokens only

keep-all-tokensKeep ID, access and refresh tokens.

quarkus.oidc.token-state-manager.split-tokens

Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size

Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_SPLIT_TOKENS

boolean

false

quarkus.oidc.token-state-manager.encryption-required

Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens.

Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED

boolean

true

quarkus.oidc.token-state-manager.encryption-secret

The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when encryption-required property is enabled.

If this secret is not set, the client secret configured with either quarkus.oidc.credentials.secret or quarkus.oidc.credentials.client-secret.value is checked. Finally, quarkus.oidc.credentials.jwt.secret which can be used for client_jwt_secret authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required.

The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters.

Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_SECRET

string

quarkus.oidc.token-state-manager.encryption-algorithm

Session cookie key encryption algorithm

Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM

a256-gcmkwContent encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content., dirThe configured key encryption secret will be used as the content encryption key to encrypt the session cookie content. Using the direct encryption avoids a content encryption key generation step and will make the encrypted session cookie sequence slightly shorter. Avoid using the direct encryption if the encryption secret is less than 32 characters long.

quarkus.oidc.allow-token-introspection-cache

Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see OidcConfig.TokenCache to enable it.

Environment variable: QUARKUS_OIDC_ALLOW_TOKEN_INTROSPECTION_CACHE

boolean

true

quarkus.oidc.allow-user-info-cache

Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see OidcConfig.TokenCache to enable it.

Environment variable: QUARKUS_OIDC_ALLOW_USER_INFO_CACHE

boolean

true

quarkus.oidc.cache-user-info-in-idtoken

Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.

Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the allow-user-info-cache property set to false.

Environment variable: QUARKUS_OIDC_CACHE_USER_INFO_IN_IDTOKEN

boolean

quarkus.oidc.jwks.resolve-early

If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.

Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.

Environment variable: QUARKUS_OIDC_JWKS_RESOLVE_EARLY

boolean

true

quarkus.oidc.jwks.cache-size

Maximum number of JWK keys that can be cached. This property is ignored if the resolve-early property is set to true.

Environment variable: QUARKUS_OIDC_JWKS_CACHE_SIZE

int

10

quarkus.oidc.jwks.cache-time-to-live

Number of minutes a JWK key can be cached for. This property is ignored if the resolve-early property is set to true.

Environment variable: QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE

Duration

10M

quarkus.oidc.jwks.clean-up-timer-interval

Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the resolve-early property is set to true.

Environment variable: QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL

Duration

quarkus.oidc.jwks.try-all

In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.

Environment variable: QUARKUS_OIDC_JWKS_TRY_ALL

boolean

false

quarkus.oidc.provider

Well known OpenId Connect provider identifier

Environment variable: QUARKUS_OIDC_PROVIDER

apple, discord, facebook, github, google, linkedin, mastodon, microsoft, spotify, strava, twitch, twitter, x

quarkus.oidc.token-cache.max-size

Maximum number of cache entries. Set it to a positive value if the cache has to be enabled.

Environment variable: QUARKUS_OIDC_TOKEN_CACHE_MAX_SIZE

int

0

quarkus.oidc.token-cache.time-to-live

Maximum amount of time a given cache entry is valid for.

Environment variable: QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE

Duration

3M

quarkus.oidc.token-cache.clean-up-timer-interval

Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically.

Environment variable: QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL

Duration

quarkus.oidc.resolve-tenants-with-issuer

If OIDC tenants should be resolved using the bearer access token’s issuer (iss) claim value.

Environment variable: QUARKUS_OIDC_RESOLVE_TENANTS_WITH_ISSUER

boolean

false

Additional named tenants

Type

Default

quarkus.oidc."tenant".auth-server-url

Environment variable: QUARKUS_OIDC__TENANT__AUTH_SERVER_URL

string

quarkus.oidc."tenant".discovery-enabled

Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.

Environment variable: QUARKUS_OIDC__TENANT__DISCOVERY_ENABLED

boolean

true

quarkus.oidc."tenant".registration-path

The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if discovery-enabled is false or a discovered token endpoint path must be customized.

Environment variable: QUARKUS_OIDC__TENANT__REGISTRATION_PATH

string

quarkus.oidc."tenant".connection-delay

Environment variable: QUARKUS_OIDC__TENANT__CONNECTION_DELAY

Duration

quarkus.oidc."tenant".connection-retry-count

Environment variable: QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT

int

3

quarkus.oidc."tenant".connection-timeout

The number of seconds after which the current OIDC connection request times out.

Environment variable: QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT

Duration

10S

quarkus.oidc."tenant".use-blocking-dns-lookup

Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server.

Environment variable: QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP

boolean

false

quarkus.oidc."tenant".max-pool-size

The maximum size of the connection pool used by the WebClient.

Environment variable: QUARKUS_OIDC__TENANT__MAX_POOL_SIZE

int

quarkus.oidc."tenant".proxy.host

The host name or IP address of the Proxy.
Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy.

Environment variable: QUARKUS_OIDC__TENANT__PROXY_HOST

string

quarkus.oidc."tenant".proxy.port

The port number of the Proxy. The default value is 80.

Environment variable: QUARKUS_OIDC__TENANT__PROXY_PORT

int

80

quarkus.oidc."tenant".proxy.username

The username, if the Proxy needs authentication.

Environment variable: QUARKUS_OIDC__TENANT__PROXY_USERNAME

string

quarkus.oidc."tenant".proxy.password

The password, if the Proxy needs authentication.

Environment variable: QUARKUS_OIDC__TENANT__PROXY_PASSWORD

string

quarkus.oidc."tenant".tls.tls-configuration-name

The name of the TLS configuration to use.

If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

The default TLS configuration is not used by default.

Environment variable: QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME

string

quarkus.oidc."tenant".token-path

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_PATH

string

quarkus.oidc."tenant".revoke-path

The relative path or absolute URL of the OIDC token revocation endpoint.

Environment variable: QUARKUS_OIDC__TENANT__REVOKE_PATH

string

quarkus.oidc."tenant".client-id

Environment variable: QUARKUS_OIDC__TENANT__CLIENT_ID

string

quarkus.oidc."tenant".client-name

Environment variable: QUARKUS_OIDC__TENANT__CLIENT_NAME

string

quarkus.oidc."tenant".credentials.secret

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_SECRET

string

quarkus.oidc."tenant".credentials.client-secret.value

The client secret value. This value is ignored if credentials.secret is set. Must be set unless a secret is set in client-secret or jwt client authentication is required.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_VALUE

string

quarkus.oidc."tenant".credentials.client-secret.provider.name

The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME

string

quarkus.oidc."tenant".credentials.client-secret.provider.keyring-name

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME

string

quarkus.oidc."tenant".credentials.client-secret.provider.key

The CredentialsProvider client secret key

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY

string

quarkus.oidc."tenant".credentials.client-secret.method

The authentication method. If the clientSecret.value secret is set, this method is basic by default.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_METHOD

quarkus.oidc."tenant".credentials.jwt.source

JWT token source: OIDC provider client or an existing JWT bearer token.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SOURCE

client, bearer

client

quarkus.oidc."tenant".credentials.jwt.secret

If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with key, key-file and key-store properties.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET

string

quarkus.oidc."tenant".credentials.jwt.secret-provider.name

The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_NAME

string

quarkus.oidc."tenant".credentials.jwt.secret-provider.keyring-name

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME

string

quarkus.oidc."tenant".credentials.jwt.secret-provider.key

The CredentialsProvider client secret key

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEY

string

quarkus.oidc."tenant".credentials.jwt.key

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY

string

quarkus.oidc."tenant".credentials.jwt.key-file

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_FILE

string

quarkus.oidc."tenant".credentials.jwt.key-store-file

If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with secret, key and key-file properties.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_FILE

string

quarkus.oidc."tenant".credentials.jwt.key-store-password

A parameter to specify the password of the keystore file.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_PASSWORD

string

quarkus.oidc."tenant".credentials.jwt.key-id

The private key id or alias.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_ID

string

quarkus.oidc."tenant".credentials.jwt.key-password

The private key password.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_PASSWORD

string

quarkus.oidc."tenant".credentials.jwt.audience

The JWT audience (aud) claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_AUDIENCE

string

quarkus.oidc."tenant".credentials.jwt.token-key-id

The key identifier of the signing key added as a JWT kid header.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_TOKEN_KEY_ID

string

quarkus.oidc."tenant".credentials.jwt.issuer

The issuer of the signing key added as a JWT iss claim. The default value is the client id.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ISSUER

string

quarkus.oidc."tenant".credentials.jwt.subject

Subject of the signing key added as a JWT sub claim The default value is the client id.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SUBJECT

string

quarkus.oidc."tenant".credentials.jwt.claims."claim-name"

Additional claims.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_

Map<String,String>

quarkus.oidc."tenant".credentials.jwt.signature-algorithm

The signature algorithm used for the key-file property. Supported values: RS256 (default), RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SIGNATURE_ALGORITHM

string

quarkus.oidc."tenant".credentials.jwt.lifespan

The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time.

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_LIFESPAN

int

10

quarkus.oidc."tenant".credentials.jwt.assertion

Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ASSERTION

boolean

false

quarkus.oidc."tenant".tenant-id

A unique tenant identifier. It can be set by TenantConfigResolver providers, which resolve the tenant configuration dynamically.

Environment variable: QUARKUS_OIDC__TENANT__TENANT_ID

string

quarkus.oidc."tenant".tenant-enabled

Environment variable: QUARKUS_OIDC__TENANT__TENANT_ENABLED

boolean

true

quarkus.oidc."tenant".application-type

The application type, which can be one of the following ApplicationType values.

Environment variable: QUARKUS_OIDC__TENANT__APPLICATION_TYPE

quarkus.oidc."tenant".authorization-path

Environment variable: QUARKUS_OIDC__TENANT__AUTHORIZATION_PATH

string

quarkus.oidc."tenant".user-info-path

Environment variable: QUARKUS_OIDC__TENANT__USER_INFO_PATH

string

quarkus.oidc."tenant".introspection-path

Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_PATH

string

quarkus.oidc."tenant".jwks-path

Environment variable: QUARKUS_OIDC__TENANT__JWKS_PATH

string

quarkus.oidc."tenant".end-session-path

Environment variable: QUARKUS_OIDC__TENANT__END_SESSION_PATH

string

quarkus.oidc."tenant".tenant-paths

Environment variable: QUARKUS_OIDC__TENANT__TENANT_PATHS

list of string

quarkus.oidc."tenant".public-key

The public key for the local JWT token verification. OIDC server connection is not created when this property is set.

Environment variable: QUARKUS_OIDC__TENANT__PUBLIC_KEY

string

quarkus.oidc."tenant".introspection-credentials.name

Name

Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_NAME

string

quarkus.oidc."tenant".introspection-credentials.secret

Secret

Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_SECRET

string

quarkus.oidc."tenant".introspection-credentials.include-client-id

Include OpenId Connect Client ID configured with quarkus.oidc.client-id.

Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID

boolean

true

quarkus.oidc."tenant".roles.role-claim-path

Environment variable: QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_PATH

list of string

quarkus.oidc."tenant".roles.role-claim-separator

Environment variable: QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_SEPARATOR

string

quarkus.oidc."tenant".roles.source

Source of the principal roles.

Environment variable: QUARKUS_OIDC__TENANT__ROLES_SOURCE

quarkus.oidc."tenant".token.issuer

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ISSUER

string

quarkus.oidc."tenant".token.audience

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_AUDIENCE

list of string

quarkus.oidc."tenant".token.subject-required

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_SUBJECT_REQUIRED

boolean

false

quarkus.oidc."tenant".token.required-claims."claim-name"

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_

Map<String,String>

quarkus.oidc."tenant".token.token-type

Expected token type

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_TOKEN_TYPE

string

quarkus.oidc."tenant".token.lifespan-grace

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_LIFESPAN_GRACE

int

quarkus.oidc."tenant".token.age

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_AGE

Duration

quarkus.oidc."tenant".token.issued-at-required

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ISSUED_AT_REQUIRED

boolean

true

quarkus.oidc."tenant".token.principal-claim

Name of the claim which contains a principal name. By default, the upn, preferred_username and sub claims are checked.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_PRINCIPAL_CLAIM

string

quarkus.oidc."tenant".token.refresh-expired

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REFRESH_EXPIRED

boolean

false

quarkus.oidc."tenant".token.refresh-token-time-skew

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW

Duration

quarkus.oidc."tenant".token.forced-jwk-refresh-interval

The forced JWK set refresh interval in minutes.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL

Duration

10M

quarkus.oidc."tenant".token.header

Custom HTTP header that contains a bearer token. This option is valid only when the application is of type ApplicationType#SERVICE}.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_HEADER

string

quarkus.oidc."tenant".token.authorization-scheme

HTTP Authorization header scheme.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_AUTHORIZATION_SCHEME

string

Bearer

quarkus.oidc."tenant".token.signature-algorithm

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_SIGNATURE_ALGORITHM

rs256, rs384, rs512, ps256, ps384, ps512, es256, es384, es512, eddsa

quarkus.oidc."tenant".token.decryption-key-location

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_DECRYPTION_KEY_LOCATION

string

quarkus.oidc."tenant".token.allow-jwt-introspection

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ALLOW_JWT_INTROSPECTION

boolean

true

quarkus.oidc."tenant".token.require-jwt-introspection-only

Require that JWT tokens are only introspected remotely.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY

boolean

false

quarkus.oidc."tenant".token.allow-opaque-token-introspection

Allow the remote introspection of the opaque tokens. Set this property to false if only JWT tokens are expected.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION

boolean

true

quarkus.oidc."tenant".token.customizer-name

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_CUSTOMIZER_NAME

string

quarkus.oidc."tenant".token.verify-access-token-with-user-info

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO

boolean

false

quarkus.oidc."tenant".logout.path

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_PATH

string

quarkus.oidc."tenant".logout.post-logout-path

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_PATH

string

quarkus.oidc."tenant".logout.post-logout-uri-param

Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI.

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_URI_PARAM

string

post_logout_redirect_uri

quarkus.oidc."tenant".logout.extra-params."query-parameter-name"

Additional properties which is added as the query parameters to the logout redirect URI.

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_

Map<String,String>

quarkus.oidc."tenant".logout.backchannel.path

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_PATH

string

quarkus.oidc."tenant".logout.backchannel.token-cache-size

Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE

int

10

quarkus.oidc."tenant".logout.backchannel.token-cache-time-to-live

Number of minutes a logout token can be cached for.

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE

Duration

10M

quarkus.oidc."tenant".logout.backchannel.clean-up-timer-interval

Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL

Duration

quarkus.oidc."tenant".logout.backchannel.logout-token-key

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY

string

sub

quarkus.oidc."tenant".logout.frontchannel.path

The relative path of the Front-Channel Logout endpoint at the application.

Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_FRONTCHANNEL_PATH

string

quarkus.oidc."tenant".certificate-chain.leaf-certificate-name

Common name of the leaf certificate. It must be set if the trust-store-file does not have this certificate imported.

Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME

string

quarkus.oidc."tenant".certificate-chain.trust-store-file

Truststore file which keeps thumbprints of the trusted certificates.

Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE

path

quarkus.oidc."tenant".certificate-chain.trust-store-password

A parameter to specify the password of the truststore file if it is configured with trust-store-file.

Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD

string

quarkus.oidc."tenant".certificate-chain.trust-store-cert-alias

A parameter to specify the alias of the truststore certificate.

Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS

string

quarkus.oidc."tenant".certificate-chain.trust-store-file-type

An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.

Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE

string

quarkus.oidc."tenant".authentication.response-mode

Authorization code flow response mode.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_RESPONSE_MODE

queryAuthorization response parameters are encoded in the query string added to the redirect_uri

quarkus.oidc."tenant".authentication.redirect-path

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_REDIRECT_PATH

string

quarkus.oidc."tenant".authentication.restore-path-after-redirect

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT

boolean

false

quarkus.oidc."tenant".authentication.remove-redirect-parameters

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS

boolean

true

quarkus.oidc."tenant".authentication.error-path

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ERROR_PATH

string

quarkus.oidc."tenant".authentication.session-expired-path

Relative path to the public endpoint which an authenticated user is redirected to when the session has expired.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH

string

quarkus.oidc."tenant".authentication.verify-access-token

Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow.

ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles.

Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to false if it is not required.

Bearer access token is always verified.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_VERIFY_ACCESS_TOKEN

boolean

true when access token is injected as the JsonWebToken bean, false otherwise

quarkus.oidc."tenant".authentication.force-redirect-https-scheme

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME

boolean

false

quarkus.oidc."tenant".authentication.scopes

List of scopes

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPES

list of string

quarkus.oidc."tenant".authentication.scope-separator

The separator which is used when more than one scope is configured. A single space is used by default.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPE_SEPARATOR

string

quarkus.oidc."tenant".authentication.nonce-required

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_NONCE_REQUIRED

boolean

false

quarkus.oidc."tenant".authentication.add-openid-scope

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ADD_OPENID_SCOPE

boolean

true

quarkus.oidc."tenant".authentication.extra-params."parameter-name"

Additional properties added as query parameters to the authentication redirect URI.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_

Map<String,String>

quarkus.oidc."tenant".authentication.forward-params

Request URL query parameters which, if present, are added to the authentication redirect URI.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_FORWARD_PARAMS

list of string

quarkus.oidc."tenant".authentication.cookie-force-secure

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_FORCE_SECURE

boolean

false

quarkus.oidc."tenant".authentication.cookie-suffix

Cookie name suffix. For example, a session cookie name for the default OIDC tenant is q_session but can be changed to q_session_test if this property is set to test.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SUFFIX

string

quarkus.oidc."tenant".authentication.cookie-path

Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The cookie-path-header property, if set, is checked first.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH

string

/

quarkus.oidc."tenant".authentication.cookie-path-header

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH_HEADER

string

quarkus.oidc."tenant".authentication.cookie-domain

Cookie domain parameter value which, if set, is used for the session, state and post logout cookies.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_DOMAIN

string

quarkus.oidc."tenant".authentication.cookie-same-site

SameSite attribute for the session cookie.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SAME_SITE

strict, lax, none

lax

quarkus.oidc."tenant".authentication.allow-multiple-code-flows

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS

boolean

true

quarkus.oidc."tenant".authentication.fail-on-missing-state-param

Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM

boolean

false

quarkus.oidc."tenant".authentication.user-info-required

If this property is set to true, an OIDC UserInfo endpoint is called.

It is also enabled automatically if io.quarkus.oidc.UserInfo injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_USER_INFO_REQUIRED

boolean

true when UserInfo bean is injected, false otherwise

quarkus.oidc."tenant".authentication.session-age-extension

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION

Duration

5M

quarkus.oidc."tenant".authentication.state-cookie-age

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE

Duration

5M

quarkus.oidc."tenant".authentication.java-script-auto-redirect

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT

boolean

true

quarkus.oidc."tenant".authentication.id-token-required

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ID_TOKEN_REQUIRED

boolean

true

quarkus.oidc."tenant".authentication.internal-id-token-lifespan

Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN

Duration

5M

quarkus.oidc."tenant".authentication.pkce-required

Requires that a Proof Key for Code Exchange (PKCE) is used.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_PKCE_REQUIRED

boolean

false

quarkus.oidc."tenant".authentication.state-secret

Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.

The secret is auto-generated if it remains uninitialized after checking all of these properties.

Error is reported if the secret length is less than 16 characters.

Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_SECRET

string

quarkus.oidc."tenant".code-grant.extra-params."parameter-name"

Additional parameters, in addition to the required code and redirect-uri parameters, which must be included to complete the authorization code grant request.

Environment variable: QUARKUS_OIDC__TENANT__CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_

Map<String,String>

quarkus.oidc."tenant".code-grant.headers."header-name"

Custom HTTP headers which must be sent to complete the authorization code grant request.

Environment variable: QUARKUS_OIDC__TENANT__CODE_GRANT_HEADERS__HEADER_NAME_

Map<String,String>

quarkus.oidc."tenant".token-state-manager.strategy

Default TokenStateManager strategy.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_STRATEGY

keep-all-tokensKeep ID, access and refresh tokens., id-tokenKeep ID token only, id-refresh-tokensKeep ID and refresh tokens only

keep-all-tokensKeep ID, access and refresh tokens.

quarkus.oidc."tenant".token-state-manager.split-tokens

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_SPLIT_TOKENS

boolean

false

quarkus.oidc."tenant".token-state-manager.encryption-required

Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED

boolean

true

quarkus.oidc."tenant".token-state-manager.encryption-secret

The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when encryption-required property is enabled.

The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters.

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_SECRET

string

quarkus.oidc."tenant".token-state-manager.encryption-algorithm

Session cookie key encryption algorithm

Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM

quarkus.oidc."tenant".allow-token-introspection-cache

Environment variable: QUARKUS_OIDC__TENANT__ALLOW_TOKEN_INTROSPECTION_CACHE

boolean

true

quarkus.oidc."tenant".allow-user-info-cache

Environment variable: QUARKUS_OIDC__TENANT__ALLOW_USER_INFO_CACHE

boolean

true

quarkus.oidc."tenant".cache-user-info-in-idtoken

Environment variable: QUARKUS_OIDC__TENANT__CACHE_USER_INFO_IN_IDTOKEN

boolean

quarkus.oidc."tenant".jwks.resolve-early

If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.

Environment variable: QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY

boolean

true

quarkus.oidc."tenant".jwks.cache-size

Maximum number of JWK keys that can be cached. This property is ignored if the resolve-early property is set to true.

Environment variable: QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE

int

10

quarkus.oidc."tenant".jwks.cache-time-to-live

Number of minutes a JWK key can be cached for. This property is ignored if the resolve-early property is set to true.

Environment variable: QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE

Duration

10M

quarkus.oidc."tenant".jwks.clean-up-timer-interval

Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the resolve-early property is set to true.

Environment variable: QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL

Duration

quarkus.oidc."tenant".jwks.try-all

Environment variable: QUARKUS_OIDC__TENANT__JWKS_TRY_ALL

boolean

false

quarkus.oidc."tenant".provider

Well known OpenId Connect provider identifier

Environment variable: QUARKUS_OIDC__TENANT__PROVIDER

apple, discord, facebook, github, google, linkedin, mastodon, microsoft, spotify, strava, twitch, twitter, x

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

If the value is only a number, it represents time in seconds.
If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

If the value is a number followed by h, m, or s, it is prefixed with PT.
If the value is a number followed by d, it is prefixed with P.

Keycloak Dev Services configuration

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property	Type	Default
`quarkus.keycloak.devservices.enabled` Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED` Show more	boolean	`true`
`quarkus.keycloak.devservices.image-name` The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME` Show more	string	`quay.io/keycloak/keycloak:25.0.6`
`quarkus.keycloak.devservices.keycloak-x-image` Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE` Show more	boolean
`quarkus.keycloak.devservices.shared` Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_SHARED` Show more	boolean	`true`
`quarkus.keycloak.devservices.service-name` The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME` Show more	string	`quarkus`
`quarkus.keycloak.devservices.realm-path` A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties. To learn more about Keycloak realm files, consult the Importing and Exporting Keycloak Realms documentation. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH` Show more	list of string
`quarkus.keycloak.devservices.resource-aliases."alias-name"` Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_` Show more	Map<String,String>
`quarkus.keycloak.devservices.resource-mappings."resource-name"` Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_` Show more	Map<String,String>
`quarkus.keycloak.devservices.java-opts` The `JAVA_OPTS` passed to the keycloak JVM Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS` Show more	string
`quarkus.keycloak.devservices.show-logs` Show Keycloak log messages with a "Keycloak:" prefix. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS` Show more	boolean	`false`
`quarkus.keycloak.devservices.start-command` Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND` Show more	string
`quarkus.keycloak.devservices.realm-name` The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME` Show more	string
`quarkus.keycloak.devservices.create-realm` Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM` Show more	boolean	`true`
`quarkus.keycloak.devservices.create-client` Specifies whether to create the default client id `quarkus-app` with a secret `secret` and register them if the `create-realm` property is set to true. For OIDC extension configuration properties `quarkus.oidc.client.id` and `quarkus.oidc.credentials.secret` will be configured. For OIDC Client extension configuration properties `quarkus.oidc-client.client.id` and `quarkus.oidc-client.credentials.secret` will be configured. Set to `false` if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` or registered dynamically. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT` Show more	boolean	`true`
`quarkus.keycloak.devservices.start-with-disabled-tenant` Specifies whether to start the container even if the default OIDC tenant is disabled. Setting this property to true may be necessary in a multi-tenant OIDC setup, especially when OIDC tenants are created dynamically. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT` Show more	boolean	`false`
`quarkus.keycloak.devservices.users."users"` A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_` Show more	Map<String,String>
`quarkus.keycloak.devservices.roles."role-name"` A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_` Show more	Map<String,List<String>>
`quarkus.keycloak.devservices.port` The specific port for the dev service to listen on. If not specified, a random port is selected. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_PORT` Show more	int
`quarkus.keycloak.devservices.container-env."environment-variable-name"` Environment variables to be passed to the container. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_` Show more	Map<String,String>
`quarkus.keycloak.devservices.container-memory-limit` Memory limit for Keycloak container If not specified, 750MiB is the default memory limit. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT` Show more	MemorySize	`750M`
`quarkus.keycloak.devservices.web-client-timeout` The WebClient timeout. Use this property to configure how long an HTTP client used by OIDC dev service admin client will wait for a response from OpenId Connect Provider when acquiring admin token and creating realm. Environment variable: `QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT` Show more	Duration	`4S`

Configuration property

Type

Default

quarkus.keycloak.devservices.enabled

Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED

boolean

true

quarkus.keycloak.devservices.image-name

The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like quay.io/keycloak/keycloak:19.0.3-legacy. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with -legacy. Override with quarkus.keycloak.devservices.keycloak-x-image.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME

string

quay.io/keycloak/keycloak:25.0.6

quarkus.keycloak.devservices.keycloak-x-image

Indicates if a Keycloak-X image is used. By default, the image is identified by keycloak-x in the image name. For custom images, override with quarkus.keycloak.devservices.keycloak-x-image. You do not need to set this property if the default check works.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE

boolean

quarkus.keycloak.devservices.shared

Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the quarkus-dev-service-label label, whose value is set by the service-name property. Container sharing is available only in dev mode.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_SHARED

boolean

true

quarkus.keycloak.devservices.service-name

The value of the quarkus-dev-service-keycloak label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME

string

quarkus

quarkus.keycloak.devservices.realm-path

A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.

To learn more about Keycloak realm files, consult the Importing and Exporting Keycloak Realms documentation.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH

list of string

quarkus.keycloak.devservices.resource-aliases."alias-name"

Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_

Map<String,String>

quarkus.keycloak.devservices.resource-mappings."resource-name"

Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_

Map<String,String>

quarkus.keycloak.devservices.java-opts

The JAVA_OPTS passed to the keycloak JVM

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS

string

quarkus.keycloak.devservices.show-logs

Show Keycloak log messages with a "Keycloak:" prefix.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS

boolean

false

quarkus.keycloak.devservices.start-command

Keycloak start command. Use this property to experiment with Keycloak start options, see https://www.keycloak.org/server/all-config. Note, it is ignored when loading legacy Keycloak WildFly images.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND

string

quarkus.keycloak.devservices.realm-name

The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the realm-path property does not exist. The default value is quarkus in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME

string

quarkus.keycloak.devservices.create-realm

Specifies whether to create the Keycloak realm when no realm file is found at the realm-path. Set to false if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by io.quarkus.test.common.QuarkusTestResourceLifecycleManager.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM

boolean

true

quarkus.keycloak.devservices.create-client

Specifies whether to create the default client id quarkus-app with a secret secret and register them if the create-realm property is set to true. For OIDC extension configuration properties quarkus.oidc.client.id and quarkus.oidc.credentials.secret will be configured. For OIDC Client extension configuration properties quarkus.oidc-client.client.id and quarkus.oidc-client.credentials.secret will be configured. Set to false if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by io.quarkus.test.common.QuarkusTestResourceLifecycleManager or registered dynamically.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT

boolean

true

quarkus.keycloak.devservices.start-with-disabled-tenant

Specifies whether to start the container even if the default OIDC tenant is disabled. Setting this property to true may be necessary in a multi-tenant OIDC setup, especially when OIDC tenants are created dynamically.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT

boolean

false

quarkus.keycloak.devservices.users."users"

A map of Keycloak usernames to passwords. If empty, default users alice and bob are created with their names as passwords. This map is used for user creation when no realm file is found at the realm-path.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_

Map<String,String>

quarkus.keycloak.devservices.roles."role-name"

A map of roles for Keycloak users. If empty, default roles are assigned: alice receives admin and user roles, while other users receive user role. This map is used for role creation when no realm file is found at the realm-path.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_

Map<String,List<String>>

quarkus.keycloak.devservices.port

The specific port for the dev service to listen on.

If not specified, a random port is selected.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_PORT

int

quarkus.keycloak.devservices.container-env."environment-variable-name"

Environment variables to be passed to the container.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_

Map<String,String>

quarkus.keycloak.devservices.container-memory-limit

Memory limit for Keycloak container

If not specified, 750MiB is the default memory limit.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT

MemorySize

750M

quarkus.keycloak.devservices.web-client-timeout

The WebClient timeout. Use this property to configure how long an HTTP client used by OIDC dev service admin client will wait for a response from OpenId Connect Provider when acquiring admin token and creating realm.

Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT

Duration

4S

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

If the value is only a number, it represents time in seconds.
If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

If the value is a number followed by h, m, or s, it is prefixed with PT.
If the value is a number followed by d, it is prefixed with P.

About the MemorySize format

A size configuration option recognizes strings in this format (shown as a regular expression): [0-9]+[KkMmGgTtPpEeZzYy]?.

If no suffix is given, assume bytes.

References

OIDC configuration
Keycloak Dev Services configuration
References

OpenID Connect (OIDC) configuration properties

OIDC configuration

Keycloak Dev Services configuration

References

Related content

On the same extensions

On the same topics