Configuration Reference¶

This page contains the list of all available Airflow configurations for the apache-airflow-providers-keycloak provider that can be set in the airflow.cfg file or using environment variables.

Note

The configuration embedded in providers started to be used as of Airflow 2.7.0. Previously the configuration was described and configured in the Airflow core package - so if you are using Airflow below 2.7.0, look at Airflow documentation for the list of available configuration options that were available in Airflow core.

Note

For more information see Setting Configuration Options.

[keycloak_auth_manager]¶

This section contains settings for Keycloak auth manager integration.

client_id¶

Added in version 1.0.0.

Client ID configured in Keycloak to integrate with Airflow. This client must follow the standard OpenID Connect authentication flow.

Type:: string
Default:: None
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__CLIENT_ID

client_secret¶

Added in version 1.0.0.

Secret associated to the client configured in Keycloak to integrate with Airflow.

Type:: string
Default:: None
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__CLIENT_SECRET

realm¶

Added in version 1.0.0.

Realm configured in Keycloak associated to Airflow. This realm define all users, roles and groups used in Airflow.

Type:: string
Default:: None
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__REALM

server_url¶

Added in version 1.0.0.

Keycloak server URL. This server URL is used by the Airflow API server to communicate with Keycloak. If the Airflow API server and Keycloak are running in Docker, set “http://host.docker.internal:<PORT>” (default value).

Type:: string
Default:: http://host.docker.internal:48080
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__SERVER_URL