API reference

• Stable public API
  • Primary building blocks
  • Supporting public types
  • Why TokenStore is listed with the main entry points
  • Guidance
• py_oidc_auth_client
  • Quick start
  • Non interactive / batch mode
  • Multiple servers
  • CLI usage
• AuthError
  • AuthError.message
  • AuthError.detail
  • AuthError.status_code
• BaseFlow
  • BaseFlow.refresh()
  • BaseFlow.reset_instances()
  • BaseFlow.session
  • BaseFlow.token
• CodeFlow
  • CodeFlow.authenticate()
• Config
  • Config.app_name
  • Config.device_route
  • Config.host
  • Config.login_route
  • Config.redirect_ports
  • Config.token_env_var
  • Config.token_route
• DeviceCode
  • DeviceCode.uri
  • DeviceCode.user_code
  • DeviceCode.device_code
  • DeviceCode.interval
  • DeviceCode.device_code
  • DeviceCode.interval
  • DeviceCode.uri
  • DeviceCode.user_code
• DeviceFlow
  • DeviceFlow.authenticate()
  • DeviceFlow.get_device_code()
  • DeviceFlow.poll()
• Token
  • Token.access_token
  • Token.token_type
  • Token.expires
  • Token.refresh_token
  • Token.refresh_expires
  • Token.scope
  • Token.headers
  • Token.access_token
  • Token.expires
  • Token.headers
  • Token.refresh_expires
  • Token.refresh_token
  • Token.scope
  • Token.token_type
• TokenStore
  • TokenStore.clear()
  • TokenStore.get()
  • TokenStore.hosts()
  • TokenStore.put()
  • TokenStore.remove()
• authenticate()
• authenticate_async()
• Authentication Flows
  • Quick start
• BaseFlow
  • BaseFlow.refresh()
  • BaseFlow.reset_instances()
  • BaseFlow.session
  • BaseFlow.token
• CodeFlow
  • CodeFlow.authenticate()
• DeviceFlow
  • DeviceFlow.authenticate()
  • DeviceFlow.get_device_code()
  • DeviceFlow.poll()
• Data Models
• DeviceCode
  • DeviceCode.uri
  • DeviceCode.user_code
  • DeviceCode.device_code
  • DeviceCode.interval
  • DeviceCode.device_code
  • DeviceCode.interval
  • DeviceCode.uri
  • DeviceCode.user_code
• Token
  • Token.access_token
  • Token.token_type
  • Token.expires
  • Token.refresh_token
  • Token.refresh_expires
  • Token.scope
  • Token.headers
  • Token.access_token
  • Token.expires
  • Token.headers
  • Token.refresh_expires
  • Token.refresh_token
  • Token.scope
  • Token.token_type
• Utilities
• Config
  • Config.app_name
  • Config.device_route
  • Config.host
  • Config.login_route
  • Config.redirect_ports
  • 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
  • AuthError.message
  • AuthError.detail
  • AuthError.status_code