This is an automated email from the ASF dual-hosted git repository.
vincbeck pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 80377dd1b7f #59475 (docs): added few clarification docs for OAuth
Authentication type (#60109)
80377dd1b7f is described below
commit 80377dd1b7f43bb11d6c48c70b104b4f208867d6
Author: anishgirianish <[email protected]>
AuthorDate: Mon Jan 5 09:20:52 2026 -0600
#59475 (docs): added few clarification docs for OAuth Authentication type
(#60109)
---
.../docs/auth-manager/configuring-flask-app.rst | 2 +-
providers/fab/docs/auth-manager/sso.rst | 34 +++++++++++++++++++---
2 files changed, 31 insertions(+), 5 deletions(-)
diff --git a/providers/fab/docs/auth-manager/configuring-flask-app.rst
b/providers/fab/docs/auth-manager/configuring-flask-app.rst
index 09a9305ade1..3395be1d57f 100644
--- a/providers/fab/docs/auth-manager/configuring-flask-app.rst
+++ b/providers/fab/docs/auth-manager/configuring-flask-app.rst
@@ -33,6 +33,6 @@ as the `app context
<https://flask.palletsprojects.com/en/2.3.x/appcontext/>`_ i
from flask import current_app as app
- @app.before_requestq
+ @app.before_request
def print_custom_message() -> None:
print("Executing before every request")
diff --git a/providers/fab/docs/auth-manager/sso.rst
b/providers/fab/docs/auth-manager/sso.rst
index 40a87c49ba2..2989123deab 100644
--- a/providers/fab/docs/auth-manager/sso.rst
+++ b/providers/fab/docs/auth-manager/sso.rst
@@ -59,7 +59,33 @@ Configuration Steps
This replaces the default ``SimpleAuthManager``.
-2. **Install Required Packages**
+2. **Enable OAuth Authentication Type**
+
+ Set ``AUTH_TYPE`` to ``AUTH_OAUTH`` in your ``webserver_config.py`` file
+ (located at ``$AIRFLOW_HOME/webserver_config.py`` by default, configurable
via
+ ``[fab] config_file`` in ``airflow.cfg``):
+
+ .. code-block:: python
+
+ from flask_appbuilder.const import AUTH_OAUTH
+
+ AUTH_TYPE = AUTH_OAUTH
+
+ .. important::
+ This step is required. Without setting ``AUTH_TYPE = AUTH_OAUTH``,
+ the OAuth providers will not be activated even if ``OAUTH_PROVIDERS``
+ is configured. The default ``AUTH_TYPE = AUTH_DB`` uses database
+ authentication only.
+
+ .. note::
+ If the ``webserver_config.py`` file does not exist in your environment,
+ you need to create it manually. A template with default values and
examples
+ can be found in the Airflow source at
+
``airflow-core/src/airflow/config_templates/default_webserver_config.py``.
+ You can copy this file to ``$AIRFLOW_HOME/webserver_config.py`` and
modify
+ it for your needs.
+
+3. **Install Required Packages**
If not already installed, ensure the FAB provider is available:
@@ -71,7 +97,7 @@ Configuration Steps
The FAB Auth Manager provider is not installed by default in Airflow 3.
You must install it explicitly to use OAuth2-based SSO.
-3. **Configure OAuth2 Provider**
+4. **Configure OAuth2 Provider**
FAB Auth Manager reads provider configuration from the ``[fab]`` section
of ``airflow.cfg`` or from environment variables.
@@ -119,13 +145,13 @@ Configuration Steps
Adjust these values according to your provider's documentation.
-4. **Restart Airflow Webserver**
+5. **Restart Airflow Webserver**
.. code-block:: bash
airflow webserver --reload
-5. **Test SSO Login**
+6. **Test SSO Login**
Open the Airflow UI. You should see a login option for your SSO provider.
