defaultAuthConfig top-level property

Map<String, dynamic> defaultAuthConfig
final

Authentication Configuration.

Guards

  • bearer / sanctum - Bearer token (default)
  • basic - HTTP Basic auth
  • api_key - API key auth

Features

  • User caching (instant restore)
  • Auto token refresh on 401
  • Driver-agnostic interceptors

Implementation

final Map<String, dynamic> defaultAuthConfig = {
  'auth': {
    // -------------------------------------------------------------------------
    // Defaults
    // -------------------------------------------------------------------------
    'defaults': {'guard': 'api'},

    // -------------------------------------------------------------------------
    // Guards
    // -------------------------------------------------------------------------
    'guards': {
      'api': {'driver': 'bearer'},
    },

    // -------------------------------------------------------------------------
    // Endpoints
    // -------------------------------------------------------------------------
    'endpoints': {
      'user': '/api/user', // Fetch user on restore
      'refresh': '/api/refresh', // Refresh access token
    },

    // -------------------------------------------------------------------------
    // Token
    // -------------------------------------------------------------------------
    'token': {
      'key': 'auth_token',
      'refresh_key': 'refresh_token',
      'header': 'Authorization',
      'prefix': 'Bearer',
    },

    // -------------------------------------------------------------------------
    // Cache
    // -------------------------------------------------------------------------
    'cache': {'user_key': 'auth_user'},

    // -------------------------------------------------------------------------
    // Auto Restore
    // -------------------------------------------------------------------------
    'auto_refresh': true,
  },
};