Skip to main content
Version: 8.2

Configuration variables

As a Spring Boot application, Identity supports any standard Spring configuration method.

Core configuration

Environment variableDescriptionDefault value
IDENTITY_AUTH_PROVIDER_BACKEND_URLUsed to support container to container communication.http://localhost:18080/auth/realms/camunda-platform
IDENTITY_AUTH_PROVIDER_ISSUER_URLUsed to denote the token issuer.http://localhost:18080/auth/realms/camunda-platform
IDENTITY_BASE_PATHUsed to configure Identity to run on a subpath (Requires HTTPs for IDENTITY_URL).
IDENTITY_CLIENT_IDThe client ID for the Identity client.camunda-identity
IDENTITY_CLIENT_SECRETThe client secret for the Identity client.
IDENTITY_LOG_LEVELThe level of which to log messages at.INFO
IDENTITY_LOG_PATTERNThe pattern to use when logging.%clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{%5p} %clr{${sys:PID}}{magenta} %clr{---}{faint} %clr{[%15.15t]}{faint} %clr{%-40.40c{1.}}{cyan} %clr{:}{faint} %m%n%xwEx
IDENTITY_URLThe URL of the Identity service.http://localhost:8080
KEYCLOAK_REALMThe name of the Keycloak Realm to connect to.camunda-platform
KEYCLOAK_SETUP_USERThe username of a user with admin access to Keycloak.admin
KEYCLOAK_SETUP_PASSWORDThe password of a user with admin access to Keycloak.admin
KEYCLOAK_SETUP_REALMThe realm that the setup user is in.master
KEYCLOAK_SETUP_CLIENT_IDThe client to use for authentication during setup of the provided Keycloak.admin-cli
KEYCLOAK_URLThe URL of the Keycloak instance to use.http://localhost:18080/auth

Component configuration

Identity supports component configuration using preset values. To configure a component for use within Identity, set two variables:

Environment variableDescriptionDefault value
KEYCLOAK_INIT_<COMPONENT>_SECRETThe secret used for authentication flows.No default
KEYCLOAK_INIT_<COMPONENT>_ROOT_URLThe root URL of where the component is hosted.No default
note

Identity supports the following values for the <COMPONENT> placeholder: OPERATE, OPTIMIZE, TASKLIST, and WEBMODELER.

For the WEBMODELER value, only the KEYCLOAK_INIT_<COMPONENT>_ROOT_URL variable is required to be set.

Database configuration

Environment variableDescription
IDENTITY_DATABASE_HOSTThe host of the database.
IDENTITY_DATABASE_PORTThe port of the database.
IDENTITY_DATABASE_NAMEThe name of the database to connect to.
IDENTITY_DATABASE_USERNAMEThe username of a user with access to the database.
IDENTITY_DATABASE_PASSWORDThe password of a user with access to the database.
note

There are no default values for the variables above. See supported environments for a list of supported databases.

Feature flags

Identity uses feature flag environment variables to enable and disable features; the supported flags are:

Environment variableDescriptionDefault value
RESOURCE_PERMISSIONS_ENABLEDControls the resource authorizations feature.false
note

Setting the RESOURCE_PERMISSIONS_ENABLED flag to true requires a database connection. To configure a database connection, see database configuration.