summaryrefslogtreecommitdiff
path: root/docs/zcml/repozewho1authenticationpolicy.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-01-18 12:25:56 -0500
committerChris McDonough <chrism@plope.com>2011-01-18 12:25:56 -0500
commitc9c3c487bcaedeca97bb6463a00188b0dc01203a (patch)
tree5de4e743b2c007c0d5202db7be883d21cfe2bc88 /docs/zcml/repozewho1authenticationpolicy.rst
parent47af907429cb038108d8daa8dafcc86fd7bf2be4 (diff)
downloadpyramid-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/repozewho1authenticationpolicy.rst')
-rw-r--r--docs/zcml/repozewho1authenticationpolicy.rst53
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/zcml/repozewho1authenticationpolicy.rst b/docs/zcml/repozewho1authenticationpolicy.rst
deleted file mode 100644
index 11907ce31..000000000
--- a/docs/zcml/repozewho1authenticationpolicy.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-.. _repozewho1authenticationpolicy_directive:
-
-``repozewho1authenticationpolicy``
-----------------------------------
-
-When this directive is used, authentication information is obtained
-from a ``repoze.who.identity`` key in the WSGI environment, assumed to
-be set by :term:`repoze.who` middleware.
-
-Attributes
-~~~~~~~~~~
-
-``identifier_name``
- The ``identifier_name`` controls the name used to look up the
- :term:`repoze.who` "identifier" plugin within
- ``request.environ['repoze.who.plugins']`` which is used by this
- policy to "remember" and "forget" credentials. It defaults to
- ``auth_tkt``.
-
-``callback``
- The ``callback`` is a Python dotted name to a function passed the
- repoze.who identity and the request as positional arguments. The
- callback is expected to return None if the user represented by the
- identity 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:
-
- <repozewho1authenticationpolicy
- identifier_name="auth_tkt"
- callback=".somemodule.somefunc"
- />
-
-Alternatives
-~~~~~~~~~~~~
-
-You may create an instance of the
-:class:`pyramid.authentication.RepozeWho1AuthenticationPolicy` 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.RepozeWho1AuthenticationPolicy`.