You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by rn...@apache.org on 2020/04/27 20:11:59 UTC
[couchdb-documentation] 05/10: address review comments
This is an automated email from the ASF dual-hosted git repository.
rnewson pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 37bf7c96de78b3834885d46851a849a0fef8f9c4
Author: Robert Newson <ro...@uk.ibm.com>
AuthorDate: Mon Apr 27 16:05:36 2020 +0100
address review comments
---
src/api/server/authn.rst | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/api/server/authn.rst b/src/api/server/authn.rst
index b49ea51..ab0b3d4 100644
--- a/src/api/server/authn.rst
+++ b/src/api/server/authn.rst
@@ -381,9 +381,10 @@ Two sections of config exist to configure JWT authentication;
; List of claims to validate
; required_claims =
-The `required_claims` config setting is a comma-separated list of additional mandatory
-JWT claims that must be present in any presented JWT token. A `:code 400:Bad Request` is sent
-if any are missing.
+The :config:option:`required_claims <jwt_auth/required_claims>` config
+setting is a comma-separated list of additional mandatory JWT claims
+that must be present in any presented JWT token. A `:code 400:Bad
+Request` is sent if any are missing.
The ``alg`` claim is mandatory as it used to lookup the correct key for verifying the
signature.
@@ -391,9 +392,9 @@ signature.
The ``sub`` claim is mandatory and is used as the CouchDB user's name if the JWT token
is valid.
-A private claim called ``_couchdb.roles`` is optional. If presented, it is a JSON
-array of strings, as is used as the CouchDB user's roles list if the JWT token
-is valid.
+A private claim called ``_couchdb.roles`` is optional. If presented,
+it is a JSON array of strings, it is used as the CouchDB user's roles
+list as long as the JWT token is valid.
.. code-block:: ini