summaryrefslogtreecommitdiff
path: root/docs/zcml/remoteuserauthenticationpolicy.rst
diff options
context:
space:
mode:
authorCasey Duncan <casey.duncan@gmail.com>2011-01-18 23:05:54 -0700
committerCasey Duncan <casey.duncan@gmail.com>2011-01-18 23:05:54 -0700
commitb0240d3d5a39a504d5a5155a23a6d6a431b457ef (patch)
treeb0c3b4f5dd8a0ec1c01912bfeff769d1329a9c97 /docs/zcml/remoteuserauthenticationpolicy.rst
parent278b302270823336d770761aaac22d854e348ea6 (diff)
parent48bccbe4ff7351d823a471005effea1afc06bb4f (diff)
downloadpyramid-b0240d3d5a39a504d5a5155a23a6d6a431b457ef.tar.gz
pyramid-b0240d3d5a39a504d5a5155a23a6d6a431b457ef.tar.bz2
pyramid-b0240d3d5a39a504d5a5155a23a6d6a431b457ef.zip
Merge https://github.com/Pylons/pyramid
Diffstat (limited to 'docs/zcml/remoteuserauthenticationpolicy.rst')
-rw-r--r--docs/zcml/remoteuserauthenticationpolicy.rst51
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/zcml/remoteuserauthenticationpolicy.rst b/docs/zcml/remoteuserauthenticationpolicy.rst
deleted file mode 100644
index 56e73ee7a..000000000
--- a/docs/zcml/remoteuserauthenticationpolicy.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-.. _remoteuserauthenticationpolicy_directive:
-
-``remoteuserauthenticationpolicy``
-----------------------------------
-
-When this directive is used, authentication information is obtained
-from a ``REMOTE_USER`` key in the WSGI environment, assumed to
-be set by a WSGI server or an upstream middleware component.
-
-Attributes
-~~~~~~~~~~
-
-``environ_key``
- The ``environ_key`` is the name that will be used to obtain the
- remote user value from the WSGI environment. It defaults to
- ``REMOTE_USER``.
-
-``callback``
- The ``callback`` is a Python dotted name to a function passed the
- string representing the remote user and the request as positional
- arguments. The callback is expected to return None if the user
- represented by the string doesn't exist or a sequence of group
- identifiers (possibly empty) if the user does exist. If
- ``callback`` is None, the userid will be assumed to exist with no
- groups. It defaults to ``None``.
-
-Example
-~~~~~~~
-
-.. code-block:: xml
- :linenos:
-
- <remoteuserauthenticationpolicy
- environ_key="REMOTE_USER"
- callback=".somemodule.somefunc"
- />
-
-Alternatives
-~~~~~~~~~~~~
-
-You may create an instance of the
-:class:`pyramid.authentication.RemoteUserAuthenticationPolicy` and
-pass it to the :class:`pyramid.config.Configurator`
-constructor as the ``authentication_policy`` argument during initial
-application configuration.
-
-See Also
-~~~~~~~~
-
-See also :ref:`authentication_policies_directives_section` and
-:class:`pyramid.authentication.RemoteUserAuthenticationPolicy`.