AuthErrorChallenge

class gafaelfawr.models.auth.AuthErrorChallenge(auth_type, realm, error, error_description, scope=None)

Bases: AuthChallenge

Represents a WWW-Authenticate header for an error challenge.

Parameters:

• auth_type (AuthType)

• realm (str)

• error (AuthError)

• error_description (str)

• scope (str | None, default: None)

Attributes Summary

auth_type	The authentication type (the first part of the header).
error	Short error code.
error_description	Human-readable error description.
realm	The value of the realm attribute.
scope	Scope required to access this URL.

Methods Summary

to_header()

Construct the WWW-Authenticate header for this challenge.

Attributes Documentation

auth_type: AuthType = <dataclasses._MISSING_TYPE object>

The authentication type (the first part of the header).

error: AuthError = <dataclasses._MISSING_TYPE object>

Short error code.

error_description: str = <dataclasses._MISSING_TYPE object>

Human-readable error description.

realm: str = <dataclasses._MISSING_TYPE object>

The value of the realm attribute.

scope: str | None = None

Scope required to access this URL.

Methods Documentation

to_header()

Construct the WWW-Authenticate header for this challenge.

Returns:

Contents of the WWW-Authenticate header.

Return type:

str