diff options
| author | Chris McDonough <chrism@plope.com> | 2011-01-18 12:25:56 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2011-01-18 12:25:56 -0500 |
| commit | c9c3c487bcaedeca97bb6463a00188b0dc01203a (patch) | |
| tree | 5de4e743b2c007c0d5202db7be883d21cfe2bc88 /docs/zcml/remoteuserauthenticationpolicy.rst | |
| parent | 47af907429cb038108d8daa8dafcc86fd7bf2be4 (diff) | |
| download | pyramid-c9c3c487bcaedeca97bb6463a00188b0dc01203a.tar.gz pyramid-c9c3c487bcaedeca97bb6463a00188b0dc01203a.tar.bz2 pyramid-c9c3c487bcaedeca97bb6463a00188b0dc01203a.zip | |
- Most references to ZCML in narrative chapters have been removed or
redirected to ``pyramid_zcml`` locations.
Diffstat (limited to 'docs/zcml/remoteuserauthenticationpolicy.rst')
| -rw-r--r-- | docs/zcml/remoteuserauthenticationpolicy.rst | 51 |
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`. |
