AuthMiddleware.apiKey constructor

AuthMiddleware.apiKey(
  1. String headerName, {
  2. AuthManager? authManager,
  3. String guard = 'api',
  4. List<String> roles = const [],
  5. List<String> permissions = const [],
  6. bool cacheUser = false,
  7. MiddlewarePriority priority = MiddlewarePriority.auth,
  8. String? name,
})

Creates an API key authentication middleware

Implementation

factory AuthMiddleware.apiKey(
  String headerName, {
  AuthManager? authManager,
  String guard = 'api',
  List<String> roles = const [],
  List<String> permissions = const [],
  bool cacheUser = false,
  MiddlewarePriority priority = MiddlewarePriority.auth,
  String? name,
}) {
  final config = AuthMiddlewareConfig(
    authType: AuthType.apiKey,
    authManager: authManager,
    guard: guard,
    apiKeyHeader: headerName,
    roles: roles,
    permissions: permissions,
    cacheUser: cacheUser,
    priority: priority,
    name: name ?? 'auth-api-key-$headerName',
  );

  return AuthMiddleware._(config, _createHandler(config));
}