From b502775254714d75177c47312cda6205b39bb4a2 Mon Sep 17 00:00:00 2001 From: Wojciech Maciejewski Date: Mon, 28 Nov 2022 08:40:47 +0100 Subject: [PATCH] DR2-114 | Update documentation --- docs/endpoints.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/endpoints.rst b/docs/endpoints.rst index b3e2bbda..86cf875a 100644 --- a/docs/endpoints.rst +++ b/docs/endpoints.rst @@ -86,6 +86,7 @@ MFA method deactivation *********************** | Deactivates the specified method. Depending on :doc: `settings` sends out an authentication code and requires confirmation. +| If you've set the ``CONFIRM_DISABLE_WITH_CODE`` option to ``True`` in the :doc: `settings` then passing the ``code`` in request payload is required. | Note: You can deactivate a primary MFA method only if it's the last active method assigned to a user. | However, you cannot deactivate a primary MFA method if there are other methods active. | You should change primary method to a different one first, and then deactivate the method. @@ -244,7 +245,7 @@ Login - second step (JWT example) ************************* Generate new backup codes ************************* - +| To use this Endpoint you've to set the ``ALLOW_BACKUP_CODES_REGENERATION`` option to ``True`` in the :doc: `settings`. | If you've set the ``CONFIRM_BACKUP_CODES_REGENERATION_WITH_CODE`` option to ``True`` in the :doc: `settings` then passing the ``code`` in request payload is required. .. list-table:: @@ -379,3 +380,4 @@ Change user's primary MFA method "error": "MFA Method selected as new primary method is not active" } - **HTTP status:** ``400 BAD REQUEST`` +