diff --git a/doc/source/api-configuration.rst b/doc/source/api-configuration.rst index 9e8b6ab6..1b68456c 100644 --- a/doc/source/api-configuration.rst +++ b/doc/source/api-configuration.rst @@ -54,6 +54,8 @@ For more details, click on the configuration parameters. +----------------------------------+--------------------------------------------------------+------------------------------------------------------------+ | ARA_ENV_ | ``default`` | Environment to load configuration for | +----------------------------------+--------------------------------------------------------+------------------------------------------------------------+ +| ARA_EXTERNAL_AUTH_ | ``False`` | Whether or not to enable external authentication | ++----------------------------------+--------------------------------------------------------+------------------------------------------------------------+ | ARA_LOGGING_ | See ARA_LOGGING_ | Logging configuration | +----------------------------------+--------------------------------------------------------+------------------------------------------------------------+ | ARA_LOG_LEVEL_ | ``INFO`` | Log level of the different components | @@ -418,6 +420,17 @@ or ``prod.yaml`` instead. This lets users override only the parameters they are interested in for specific environments. +ARA_EXTERNAL_AUTH +~~~~~~~~~~~~~~~~~ + +- **Environment variable**: ``ARA_EXTERNAL_AUTH`` +- **Configuration file variable**: ``EXTERNAL_AUTH`` +- **Type**: ``bool`` +- **Default**: ``False`` +- **Provided by**: django-rest-framework `authentication `_ + +Whether or not to enable external authentication. + ARA_LOGGING ~~~~~~~~~~~ diff --git a/doc/source/api-security.rst b/doc/source/api-security.rst index 6278b467..4ff34f94 100644 --- a/doc/source/api-security.rst +++ b/doc/source/api-security.rst @@ -93,6 +93,16 @@ This is done with the two following configuration options: These settings are global and are effective for all API endpoints. +Enabling external authentication +------------------------------------------------ + +Once you you have enabled authentication against the API, you can enable external +authentication. This is usefull especially in production environments. + +This is done with the following configuration option: + +- :ref:`api-configuration:ARA_EXTERNAL_AUTH` for external authentication + Setting up authentication for the Ansible plugins -------------------------------------------------