init() — fastapi Function Reference

Architecture documentation for the __init__() function in open_id_connect_url.py from the fastapi codebase.

Function python Security Schemes

Entity Profile

Security→ Schemes→ __init__() — fastapi Function Reference

Dependency Diagram

graph TD
  c07383fd_7f62_a8ad_5b3a_2df063400ebe["__init__()"]
  76b111a9_5b62_f8e0_e44a_b9a33f6470f7["OpenIdConnect"]
  c07383fd_7f62_a8ad_5b3a_2df063400ebe -->|defined in| 76b111a9_5b62_f8e0_e44a_b9a33f6470f7
  style c07383fd_7f62_a8ad_5b3a_2df063400ebe fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/security/open_id_connect_url.py lines 22–78

    def __init__(
        self,
        *,
        openIdConnectUrl: Annotated[
            str,
            Doc(
                """
            The OpenID Connect URL.
            """
            ),
        ],
        scheme_name: Annotated[
            Optional[str],
            Doc(
                """
                Security scheme name.

                It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
        ] = None,
        description: Annotated[
            Optional[str],
            Doc(
                """
                Security scheme description.

                It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
        ] = None,
        auto_error: Annotated[
            bool,
            Doc(
                """
                By default, if no HTTP Authorization header is provided, required for
                OpenID Connect authentication, it will automatically cancel the request
                and send the client an error.

                If `auto_error` is set to `False`, when the HTTP Authorization header
                is not available, instead of erroring out, the dependency result will
                be `None`.

                This is useful when you want to have optional authentication.

                It is also useful when you want to have authentication that can be
                provided in one of multiple optional ways (for example, with OpenID
                Connect or in a cookie).
                """
            ),
        ] = True,
    ):
        self.model = OpenIdConnectModel(
            openIdConnectUrl=openIdConnectUrl, description=description
        )
        self.scheme_name = scheme_name or self.__class__.__name__
        self.auto_error = auto_error