falcon_auth2/backends/base.py
def authenticate(self, attributes: RequestAttributes) -> dict:
        """Authenticates the request and returns the authenticated user.

        If a request cannot be authenticated a backed should raise:

        * :class:`~.AuthenticationFailure` to indicate that the request can be handled by this
          backend, but the authentication fails.
        * :class:`~.BackendNotApplicable` if the provided request cannot be handled by this backend.
          This is usually raised by the :class:`~.Getter` used by the backend to process the
          request.
        * :class:`~.UserNotFound` when no user could be loaded with the provided credentials.

        Args:
            attributes (RequestAttributes): The current request attributes. It's a named tuple
                which contains the falcon request and response objects, the activated resource
                and the parameters matched in the url.

        Returns:
            dict: A dictionary with a required ``"user"`` key containing the authenticated
            user. This dictionary may optionally contain additional keys specific to this
            backend. If the ``"backend"`` key is specified, the middleware will not override it.
        """
Authenticates the request and returns the authenticated user.

        If a request cannot be authenticated a backed should raise:

        * :class:`~.AuthenticationFailure` to indicate that the request can be handled by this
          backend, but the authentication fails.
        * :class:`~.BackendNotApplicable` if the provided request cannot be handled by this backend.
          This is usually raised by the :class:`~.Getter` used by the backend to process the
          request.
        * :class:`~.UserNotFound` when no user could be loaded with the provided credentials.

        Args:
            attributes (RequestAttributes): The current request attributes. It's a named tuple
                which contains the falcon request and response objects, the activated resource
                and the parameters matched in the url.

        Returns:
            dict: A dictionary with a required ``"user"`` key containing the authenticated
            user. This dictionary may optionally contain additional keys specific to this
            backend. If the ``"backend"`` key is specified, the middleware will not override it.
        
Authenticates the request and returns the authenticated user.
If a request cannot be authenticated a backed should raise.

:class:`~.AuthenticationFailure` to indicate that the request can be handled by this
backend, but the authentication fails.
:class:`~.BackendNotApplicable` if the provided request cannot be handled by this backend.
This is usually raised by the :class:`~.Getter` used by the backend to process the
request.
:class:`~.UserNotFound` when no user could be loaded with the provided credentials.
Authenticates the request and returns the authenticated user . If a request cannot be authenticated a backed should raise . : class : ` ~ . AuthenticationFailure ` to indicate that the request can be handled by this backend but the authentication fails . : class : ` ~ . BackendNotApplicable ` if the provided request cannot be handled by this backend . This is usually raised by the : class : ` ~ . Getter ` used by the backend to process the request . : class : ` ~ . UserNotFound ` when no user could be loaded with the provided credentials .
def authenticate(self, attributes: RequestAttributes) -> dict:
def authenticate ( self , attributes : RequestAttributes ) -> dict :
Authenticates the request and returns the authenticated user.
Authenticates the request and returns the authenticated user .
"""Authenticates the request and returns the authenticated user.

        If a request cannot be authenticated a backed should raise:

        * :class:`~.AuthenticationFailure` to indicate that the request can be handled by this
          backend, but the authentication fails.
        * :class:`~.BackendNotApplicable` if the provided request cannot be handled by this backend.
          This is usually raised by the :class:`~.Getter` used by the backend to process the
          request.
        * :class:`~.UserNotFound` when no user could be loaded with the provided credentials.

        Args:
            attributes (RequestAttributes): The current request attributes. It's a named tuple
                which contains the falcon request and response objects, the activated resource
                and the parameters matched in the url.

        Returns:
            dict: A dictionary with a required ``"user"`` key containing the authenticated
            user. This dictionary may optionally contain additional keys specific to this
            backend. If the ``"backend"`` key is specified, the middleware will not override it.
        """
A dictionary with a required ``"user"`` key containing the authenticated
user. This dictionary may optionally contain additional keys specific to this
backend. If the ``"backend"`` key is specified, the middleware will not override it.
A dictionary with a required ` ` " user " ` ` key containing the authenticated user . This dictionary may optionally contain additional keys specific to this backend . If the ` ` " backend " ` ` key is specified the middleware will not override it .
dict
self
attributes
RequestAttributes
The current request attributes. It's a named tuple
which contains the falcon request and response objects, the activated resource
and the parameters matched in the url.
The current request attributes . It ' s a named tuple which contains the falcon request and response objects the activated resource and the parameters matched in the url .