INNER CODE UNIT · Python

claim

tokusumi/fastapi-cloudauth · fastapi_cloudauth/base.py:129

    def claim(self, schema: Optional[Type[BaseModel]] = None) -> "UserInfoAuth":
        """User verification and validation shortcut to pass it into app arguments.
        Use as (where `auth` is this instance and `app` is fastapi.FastAPI instance):
        ```
        from fastapi import Depends
        from pydantic import BaseModel

        class CustomClaim(BaseModel):
            sub: str

        @app.get("/")
        def api(user: CustomClaim = Depends(auth.claim(CustomClaim))):
            return CustomClaim
        ```
        """
        clone = self._clone()
        clone.user_info = schema
        return clone

View source record →