]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
no bug - First pass on truing up API documentation with a sec focus
authorJonathan Claudius <jclaudius@mozilla.com>
Wed, 11 Sep 2019 16:52:09 +0000 (12:52 -0400)
committerdklawren <dklawren@users.noreply.github.com>
Wed, 11 Sep 2019 16:52:09 +0000 (12:52 -0400)
docs/en/rst/api/core/v1/general.rst

index 61bdeeb60fbfc92c4e034aa987a199d53eb8b69a..8e70ace8cf82ad1edc8afeac3ca7557aa452bb70 100644 (file)
@@ -100,13 +100,20 @@ To authenticate yourself, you will need to use API keys:
 
 **API Keys**
 
-You can specify ``Bugzilla_api_key`` or simply ``api_key`` as an argument to
-any call, and you will be logged in as that user if the key is correct and has
-not been revoked. You can set up an API key by using the :ref:`API Keys tab <api-keys>` in the
+You can specify 'X-BUGZILLA-API-KEY' header with the API key as a value to
+any request, and you will be authenticated as that user if the key is correct and has not been revoked.
+
+You can set up an API key by using the :ref:`API Keys tab <api-keys>` in the
 Preferences pages.
 
 API keys may also be requested via :ref:`Authentication Delegation <auth-delegation>`.
 
+**WARNING**: It should be noted that additional authentication methods exist, but they are **not recommended** for use and are likely to be deprecated in future versions of BMO, due to security concerns.  These additional methods include the following:
+
+ - username and password via ``Bugzilla_login`` and ``Bugzilla_password`` or simply ``login`` and ``password`` respectively in query parameters.
+ - username and password via ``X-BUGZILLA-LOGIN`` and ``X-BUGZILLA-PASSWORD`` headers respectively.
+ - api key via ``Bugzilla_api_key`` or simply ``api_key`` in query parameters.
+
 Useful Parameters
 -----------------