HTTPDigest

HTTP Digest authentication.

Attributes

Attribute	Type	Description
model	HTTPBaseModel	The OpenAPI security scheme model containing the 'digest' scheme type and an optional description.
scheme_name	`str	None` = HTTPDigest
auto_error	bool = True	Determines if the request should be automatically canceled with an error or return None if HTTP Digest is not provided.

---

Constructor

Signature

def HTTPDigest(
    scheme_name: str | None = None,
    description: str | None = None,
    auto_error: bool = True
) - > null

Parameters

Name	Type	Description
scheme_name	`str	None` = None
description	`str	None` = None
auto_error	bool = True	If True, missing credentials raise an error; if False, the dependency returns None.

---

Signature

def HTTPDigest(
    scheme_name: str | None = None,
    description: str | None = None,
    auto_error: bool = True
) - > null

Parameters

Name	Type	Description
scheme_name	`str	None` = None
description	`str	None` = None
auto_error	bool = True	Determines if the method should raise an HTTP 403 error automatically when credentials are missing or invalid; set to False for optional authentication.

---