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 toREMOTE_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. Ifcallback
is None, the userid will be assumed to exist with no groups. It defaults toNone
.
Example¶
1<remoteuserauthenticationpolicy
2 environ_key="REMOTE_USER"
3 callback=".somemodule.somefunc"
4 />
Alternatives¶
You may create an instance of the
pyramid.authentication.RemoteUserAuthenticationPolicy
and
pass it to the pyramid.config.Configurator
constructor as the authentication_policy
argument during initial
application configuration.
See Also¶
See also Built-In Authentication Policy ZCML Directives and
pyramid.authentication.RemoteUserAuthenticationPolicy
.