API reference

This section documents the public Python API.

If you build the docs without installing optional framework dependencies, configure autodoc mocking or install the extras in your docs environment.

Framework integrations

• FastAPI API
  • Prompt
  • FastApiOIDCAuth
• Flask API
  • FlaskOIDCAuth
• Quart API
  • QuartOIDCAuth
• Django API
  • DjangoOIDCAuth
• Tornado API
  • TornadoOIDCAuth
• Litestar API
  • LitestarOIDCAuth

Core

• Core API
  • OIDCAuth
  • IDToken
  • Token
  • DeviceStartResponse
  • TokenisedUser
  • UserInfo
  • JWKSCache
  • TokenVerifier
  • InvalidRequest
  • process_payload()
  • OIDCConfig
  • SystemUserInfo
  • CacheTokenPayload
  • string_to_dict()
  • token_field_matches()
  • get_userinfo()
  • oidc_request()
  • query_user()
  • get_username()