Skip to main content

OAuthProvider

Base configuration and extension point for OAuth providers in Flet.

Instances describe OAuth endpoints, client credentials, optional PKCE parameters, and optional user/group retrieval behavior used by AuthorizationService.

Parameters:

  • client_id (str) - OAuth client/application ID issued by the provider.
  • client_secret (str) - OAuth client secret issued by the provider.
  • authorization_endpoint (str) - Authorization endpoint URL used to build the login redirect URL.
  • token_endpoint (str) - Token endpoint URL used for authorization-code and refresh-token exchange.
  • redirect_url (str) - Redirect/callback URL registered with the provider.
  • scopes (Optional[list[str]], default: None) - Base OAuth scopes always requested during login.
  • user_scopes (Optional[list[str]], default: None) - Additional scopes requested when user profile loading is enabled.
  • user_endpoint (Optional[str], default: None) - Endpoint used to fetch raw user profile data after login.
  • user_id_fn (Optional[Callable], default: None) - Function extracting a stable user id from user_endpoint response data.
  • group_scopes (Optional[list[str]], default: None) - Additional scopes requested when group loading is enabled.
  • code_challenge (Optional[str], default: None) - PKCE code challenge.
  • code_challenge_method (Optional[str], default: None) - PKCE challenge method. For example, S256.
  • code_verifier (Optional[str], default: None) - PKCE code verifier used during token exchange.
  • authorization_params (Optional[dict[str, str]], default: None) - Extra query parameters appended to authorization URL generation by the OAuth authorization service.

Properties

authorization_endpointinstance-attribute

authorization_paramsinstance-attribute

client_idinstance-attribute

client_secretinstance-attribute

code_challengeinstance-attribute

code_challenge_methodinstance-attribute

code_verifierinstance-attribute

group_scopesinstance-attribute

redirect_urlinstance-attribute

scopesinstance-attribute

token_endpointinstance-attribute

user_endpointinstance-attribute

user_id_fninstance-attribute

user_scopesinstance-attribute