Document openedx/core/djangoapps/user_authn feature toggles

This commit is contained in:
Régis Behmo
2020-08-19 18:06:48 +02:00
parent 9db086bf2e
commit c8892d321b
3 changed files with 140 additions and 22 deletions

View File

@@ -8,17 +8,20 @@ from openedx.core.djangoapps.waffle_utils import WaffleSwitch, WaffleSwitchNames
_WAFFLE_NAMESPACE = u'user_authn'
_WAFFLE_SWITCH_NAMESPACE = WaffleSwitchNamespace(name=_WAFFLE_NAMESPACE, log_prefix=u'UserAuthN: ')
# .. toggle_name: user_authn.enable_login_using_thirdparty_auth_only
# .. toggle_implementation: WaffleSwitch
# .. toggle_default: False
# .. toggle_description: When enabled, users must be sign in using their allowed domain SSO account.
# .. toggle_category: authn
# .. toggle_use_cases: incremental_release
# .. toggle_creation_date: 2019-11-20
# .. toggle_expiration_date: 2020-01-31
# .. toggle_warnings: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set.
# .. toggle_tickets: ENT-2461
# .. toggle_status: supported
"""
.. toggle_name: user_authn.enable_login_using_thirdparty_auth_only
.. toggle_implementation: WaffleSwitch
.. toggle_default: False
.. toggle_description: When enabled, users must be sign in using their allowed domain
SSO account. This includes sign-ins to the Django admin dashboard at "/admin".
.. toggle_category: authn
.. toggle_use_cases: incremental_release
.. toggle_creation_date: 2019-11-20
.. toggle_expiration_date: 2020-01-31
.. toggle_warnings: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set.
.. toggle_tickets: ENT-2461
.. toggle_status: supported
"""
ENABLE_LOGIN_USING_THIRDPARTY_AUTH_ONLY = WaffleSwitch(
_WAFFLE_SWITCH_NAMESPACE,
'enable_login_using_thirdparty_auth_only',