class documentation

class BasicAuthentication(BaseAuthentication): (source)

View In Hierarchy

HTTP Basic authentication against username/password.

Method authenticate Returns a `User` if a correct username and password have been supplied using HTTP Basic authentication. Otherwise returns `None`.
Method authenticate_credentials Authenticate the userid and password against username and password with optional request for context.
Method authenticate_header Return a string to be used as the value of the `WWW-Authenticate` header in a `401 Unauthenticated` response, or `None` if the authentication scheme should return `403 Permission Denied` responses.
Class Variable www_authenticate_realm Undocumented
def authenticate(self, request): (source)

Returns a `User` if a correct username and password have been supplied using HTTP Basic authentication. Otherwise returns `None`.

def authenticate_credentials(self, userid, password, request=None): (source)

Authenticate the userid and password against username and password with optional request for context.

def authenticate_header(self, request): (source)

Return a string to be used as the value of the `WWW-Authenticate` header in a `401 Unauthenticated` response, or `None` if the authentication scheme should return `403 Permission Denied` responses.

www_authenticate_realm: str = (source)

Undocumented