summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSimon Green <sgreen@redhat.com>2014-07-27 10:47:21 +0200
committerSimon Green <sgreen@redhat.com>2014-07-27 10:47:21 +0200
commitfd29ee56c4678749c00e7698ef245f7e2967ee10 (patch)
tree9d0696c9a89b8df8a6d46e2be6602a449b7354c3 /docs
parent9f0f44b7fb73e9af0cdaefe8f5ff617f14fec2ed (diff)
downloadbugzilla-fd29ee56c4678749c00e7698ef245f7e2967ee10.tar.gz
bugzilla-fd29ee56c4678749c00e7698ef245f7e2967ee10.tar.xz
Bug 726696 - All authenticated WebServices methods should require username/pass, token or a valid API key for authentication
r=dkl, a=sgreen
Diffstat (limited to 'docs')
-rw-r--r--docs/en/rst/using.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/en/rst/using.rst b/docs/en/rst/using.rst
index 5be1a2582..a98ff7680 100644
--- a/docs/en/rst/using.rst
+++ b/docs/en/rst/using.rst
@@ -1005,6 +1005,22 @@ If you attempt to change your email address, a confirmation
email is sent to both the old and new addresses, with a link to use to
confirm the change. This helps to prevent account hijacking.
+.. _apikey:
+
+API Keys
+========
+
+API keys are used to authenticate REST calls. You can create more than one
+API key if required. Each API key has an optional description which can help
+you record what each key is used for.
+
+On this page, you can unrevoke, revoke and change the description of existing
+API keys for your login. A revoked key means that it cannot be used. The
+description for purely for your information, and is optional.
+
+You can also create a new API key by selecting the check box under the 'New
+API key' section of the page.
+
.. _permissionsettings:
Permissions