pywry.auth.deploy_routes¶

FastAPI routes for OAuth2 authentication in deploy mode.

create_auth_router¶

pywry.auth.deploy_routes.create_auth_router ¶

create_auth_router(provider: OAuthProvider, session_store: SessionStore, token_store: TokenStore, deploy_settings: DeploySettings, auth_config: AuthConfig, use_pkce: bool = True) -> APIRouter

Create a FastAPI router with OAuth2 authentication routes.

Parameters:

Name	Type	Description	Default
`provider`	`OAuthProvider`	The configured OAuth2 provider.	required
`session_store`	`SessionStore`	Session store for creating/managing sessions.	required
`token_store`	`TokenStore`	Token store for persisting OAuth2 tokens.	required
`deploy_settings`	`DeploySettings`	Deploy configuration (cookie name, default roles, etc.).	required
`auth_config`	`AuthConfig`	Auth configuration (secret, session TTL, etc.).	required
`use_pkce`	`bool`	Whether to use PKCE (default True).	`True`

Returns:

Type	Description
`APIRouter`	Router with `/auth/*` routes.

cleanup_expired_states¶

pywry.auth.deploy_routes.cleanup_expired_states ¶

cleanup_expired_states(max_age: float = 600.0) -> int

Remove expired pending auth states (synchronous wrapper).

Parameters:

Name	Type	Description	Default
`max_age`	`float`	Maximum age in seconds before a state is considered expired.	`600.0`

Returns:

Type	Description
`int`	Number of expired states removed.