We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent b503b21 commit e14b485Copy full SHA for e14b485
fastapi_third_party_auth/auth.py
@@ -53,8 +53,13 @@ def __init__(
53
signature_cache_ttl: int = 3600,
54
idtoken_model: Type[IDToken] = IDToken,
55
):
56
- """Configure authentication and use method :func:`require` or :func:`optional`
57
- to check user credentials.
+ """Configure authentication :func:`auth = Auth(...) <Auth>` and then:
+
58
+ 1. Show authentication in the interactive docs with :func:`Depends(auth) <Auth>`
59
+ when setting up FastAPI.
60
+ 2. Use :func:`Security(auth.required) <Auth.required>` or
61
+ :func:`Security(auth.optional) <Auth.optional>` in your endpoints to
62
+ check user credentials.
63
64
Args:
65
openid_connect_url (URL): URL to the "well known" openid connect config
0 commit comments