plone.restapi/plone-only-login: Add documentation on authentication only with site's users

Victor Fernandez de Alba <jenkins-z4DKO/[email protected]>
Newsgroups gmane.comp.web.zope.plone.cvs
Message-ID <[email protected]>
Repository: plone.restapi
Branch: refs/heads/plone-only-login
Date: 2017-07-18T18:02:49+02:00
Author: Victor Fernandez de Alba (sneridagh) <[email protected]>
Commit: https://github.com/plone/plone.restapi/commit/bf2971e45e90d4e295dfe24adfbc487daa475904

Add documentation on authentication only with site's users

Files changed:
M docs/source/authentication.rst

diff --git a/docs/source/authentication.rst b/docs/source/authentication.rst
index 561cb015..02bcd2b0 100644
--- a/docs/source/authentication.rst
+++ b/docs/source/authentication.rst
@@ -33,6 +33,13 @@ Or the same example using ``curl``:
 
     curl -u username:password -H 'Accept:application/json' $URL
 
+.. warning::
+  The authentication endpoints will only authenticate site users. This means
+  that only users in the site's `acl_users` will be able to authenticate and
+  will be granted a token if they request one. Zope (root's `acl_users`) won't
+  be able to authenticate by Plone RESTAPI means. This is by design to avoid
+  confusion and differences of role assignment while using the RESTAPI.
+
 
 JSON Web Tokens (JWT)
 ---------------------



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.