API reference

• Stable public API
  • Primary building blocks
  • Supporting public types
  • Why TokenStore is listed with the main entry points
  • Guidance
• Authentication Flows
  • Quick start
• BaseFlow
  • BaseFlow.refresh()
  • BaseFlow.reset_instances()
  • BaseFlow.token
• CodeFlow
  • CodeFlow.authenticate()
• DeviceFlow
  • DeviceFlow.authenticate()
  • DeviceFlow.get_device_code()
  • DeviceFlow.poll()
• Supported auth backends
• ProviderBackend
  • ProviderBackend.config
  • ProviderBackend.device_authorization()
  • ProviderBackend.exchange_authorization_code()
  • ProviderBackend.get_authorization_url()
  • ProviderBackend.get_device_token()
  • ProviderBackend.post_form()
  • ProviderBackend.refresh_token()
  • ProviderBackend.session
  • ProviderBackend.timeout
• PyOIDCAuth
  • PyOIDCAuth.device_authorization()
  • PyOIDCAuth.exchange_authorization_code()
  • PyOIDCAuth.get_authorization_url()
  • PyOIDCAuth.get_device_token()
  • PyOIDCAuth.refresh_token()
• Identity
  • Auth Identity
  • AuthIdentity
  • Grant
  • normalise_host()
  • normalise_scopes()
• Token store
  • Token Store
  • StoreEntry
  • TokenStore
• Data Models
• DeviceCode
  • DeviceCode.device_code
  • DeviceCode.interval
  • DeviceCode.uri
  • DeviceCode.user_code
• Token
  • Token.access_token
  • Token.expires
  • Token.headers
  • Token.refresh_expires
  • Token.refresh_token
  • Token.scope
  • Token.token_type
• Utilities
• Config
  • Config.app_name
  • Config.client_id
  • Config.client_secret
  • Config.device_route
  • Config.discovery_document_route
  • Config.host
  • Config.login_route
  • Config.redirect_ports
  • Config.scopes
  • Config.server_key
  • Config.token_env_var
  • Config.token_route
• build_url()
• choose_token_strategy()
• clock()
• is_interactive_auth_possible()
• is_interactive_shell()
• is_job_env()
• is_jupyter_notebook()
• is_token_valid()
• pprint()
• Exceptions
• AuthError
• Types
  • DeviceAuthorizationResponse
  • JSONResponse
  • OAuthErrorResponse
  • OIDCDiscoveryDocument
  • TokenResponse