summaryrefslogtreecommitdiff
path: root/docs/zcml/repozewho1authenticatiohnpolicy.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2010-01-19 03:34:51 +0000
committerChris McDonough <chrism@agendaless.com>2010-01-19 03:34:51 +0000
commit1de5ec90e0ecb81ee1f4c4ade0b11c2cc8cf646a (patch)
treeb9209a1086b8aed62b7a451786d9e4feeb770ac8 /docs/zcml/repozewho1authenticatiohnpolicy.rst
parent37bcb77a86b73151c781d8b0b8c2d3d4e14f5fe7 (diff)
downloadpyramid-1de5ec90e0ecb81ee1f4c4ade0b11c2cc8cf646a.tar.gz
pyramid-1de5ec90e0ecb81ee1f4c4ade0b11c2cc8cf646a.tar.bz2
pyramid-1de5ec90e0ecb81ee1f4c4ade0b11c2cc8cf646a.zip
Spellcheck.
Diffstat (limited to 'docs/zcml/repozewho1authenticatiohnpolicy.rst')
-rw-r--r--docs/zcml/repozewho1authenticatiohnpolicy.rst53
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/zcml/repozewho1authenticatiohnpolicy.rst b/docs/zcml/repozewho1authenticatiohnpolicy.rst
deleted file mode 100644
index 62713e822..000000000
--- a/docs/zcml/repozewho1authenticatiohnpolicy.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:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy` and
-pass it to the :class:`repoze.bfg.configuration.Configurator`
-constructor as the ``authentication_policy`` argument during initial
-application configuration.
-
-See Also
-~~~~~~~~
-
-See also :ref:`authentication_policies_directives_section` and
-:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy`.