Discovery

OpenID Connect Discovery 1.0 document fetching and parsing.

Request / Response Models

DiscoveryDocumentRequest(address, policy=None) dataclass

Bases: BaseRequest

Request for fetching an OpenID Connect discovery document.

Attributes:

Name	Type	Description
address	str	The base URL of the identity provider (e.g. https://example.com). The well-known path is appended automatically.
policy	DiscoveryPolicy | None	Optional discovery policy for configuring validation behavior. When None, strict defaults apply.

DiscoveryDocumentResponse(is_successful, error=None, issuer=None, jwks_uri=None, authorization_endpoint=None, token_endpoint=None, response_types_supported=None, subject_types_supported=None, id_token_signing_alg_values_supported=None, userinfo_endpoint=None, registration_endpoint=None, introspection_endpoint=None, scopes_supported=None, response_modes_supported=None, grant_types_supported=None, acr_values_supported=None, id_token_encryption_alg_values_supported=None, id_token_encryption_enc_values_supported=None, userinfo_signing_alg_values_supported=None, userinfo_encryption_alg_values_supported=None, userinfo_encryption_enc_values_supported=None, request_object_signing_alg_values_supported=None, request_object_encryption_alg_values_supported=None, request_object_encryption_enc_values_supported=None, token_endpoint_auth_methods_supported=None, token_endpoint_auth_signing_alg_values_supported=None, display_values_supported=None, claim_types_supported=None, claims_supported=None, claims_locales_supported=None, ui_locales_supported=None, code_challenge_methods_supported=None, claims_parameter_supported=None, request_parameter_supported=None, request_uri_parameter_supported=None, require_request_uri_registration=None, service_documentation=None, op_policy_uri=None, op_tos_uri=None) dataclass

Bases: BaseResponse

Response from an OpenID Connect discovery document fetch.

Check is_successful before accessing data fields. Accessing guarded fields on a failed response raises FailedResponseAccessError.

Sync API

get_discovery_document(disco_doc_req, http_client=None)

Fetch discovery document from the specified address.

Parameters:

Name	Type	Description	Default
disco_doc_req	DiscoveryDocumentRequest	Discovery document request configuration	required
http_client	HTTPClient | None	Optional managed HTTP client. When None, uses the thread-local default.	None

Returns:

Name	Type	Description
DiscoveryDocumentResponse	DiscoveryDocumentResponse	Discovery document response

Async API

get_discovery_document(disco_doc_req, http_client=None) async

Fetch discovery document from the specified address (async).

Parameters:

Name	Type	Description	Default
disco_doc_req	DiscoveryDocumentRequest	Discovery document request configuration	required
http_client	AsyncHTTPClient | None	Optional managed HTTP client. When None, uses the module-level singleton.	None

Returns:

Name	Type	Description
DiscoveryDocumentResponse	DiscoveryDocumentResponse	Discovery document response