Stable public API

The following objects are the main public building blocks that user code should rely on. They form the stable API surface for common integrations.

Primary building blocks

• py_oidc_auth_client.authenticate()

• py_oidc_auth_client.authenticate_async()

• py_oidc_auth_client.CodeFlow

• py_oidc_auth_client.DeviceFlow

• py_oidc_auth_client.TokenStore

Supporting public types

• py_oidc_auth_client.Config

• py_oidc_auth_client.Token

• py_oidc_auth_client.AuthError

Why TokenStore is listed with the main entry points

TokenStore is not just a utility type. It is the public persistence layer that makes token reuse, refresh, and environment-specific separation possible. For many applications, choosing the right token storage layout is as important as choosing between authenticate(), CodeFlow, and DeviceFlow.

It also separates tokens by host internally, which means a single store can usually back multiple auth servers for the same application.

Guidance

Prefer the names above in application code, examples, and downstream integrations. If you need lower level helpers from internal modules, document that dependency explicitly because internal helpers may change more often than the public surface.