improved

SDK Auto-Configuration for FastAPI

๐Ÿ“ฃ FastAPI Auth SDK 0.3.0 Release ๐ŸŽ‰

There were several enhancements to the FastAPI Auth SDK with this release. Please refer to the GitHub README for updated documentation and details.

Below is a summary of all changes:

  • The all new SDK auto-configuration functionality is now available for the FastAPI Auth SDK. It supports both lazy and eager auto-configuration. Auto-configuration is enabled by default and will fetch missing configuration values from the Wristband SDK Configuration Endpoint when any auth method is first called. Manual configuration values take precedence over auto-configured values. Set auto_configure_enabled=False in the AuthConfig to disable.
  • The new async discover() method in WristbandAuth can be used to eager-load SDK configurations from the Wristband SDK Configuration Endpoint on server startup.
  • The login_state_secret config is no longer required. If not provided, it will default to using the client secret. For enhanced security, it is recommended to provide a value that is unique from the client secret. You can run openssl rand -base64 32 to create a secret from your CLI.
  • The LoginConfig class for the login() method now supports a returnUrl field. If a value is provided, then it takes precedence over the existing return_url request query parameter. This new login config provides the same functionality as the existing query parameter approach.
  • The LogoutConfig class for the logout() method now supports a state field. This is an optional value that allows you to preserve application state through the logout flow when redirecting to the Wristband Logout Endpoint. If provided, it will be appended as a query parameter to the resolved logout URL. Maximum length of 512 characters. This is useful for tracking logout context, displaying post-logout messages, or handling different logout scenarios.