Skip to content

DR2-114 | Update documentation #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wmaciejewskimer wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

DR2-114 | Update documentation #192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/endpoints.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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``