👁 Image
TickerQ.Dashboard 10.4.0

TickerQ Dashboard Authentication

Simple, clean authentication for your TickerQ Dashboard.

🚀 Quick Examples

No Authentication (Public Dashboard)

services.AddTickerQ<MyTimeTicker, MyCronTicker>(config =>
{
 config.AddDashboard(dashboard =>
 {
 // No authentication setup = public dashboard
 });
});

Basic Authentication

services.AddTickerQ<MyTimeTicker, MyCronTicker>(config =>
{
 config.AddDashboard(dashboard =>
 {
 dashboard.WithBasicAuth("admin", "secret123");
 });
});

API Key Authentication

services.AddTickerQ<MyTimeTicker, MyCronTicker>(config =>
{
 config.AddDashboard(dashboard =>
 {
 dashboard.WithApiKey("my-secret-api-key-12345");
 });
});

Use Host Application's Authentication

services.AddTickerQ<MyTimeTicker, MyCronTicker>(config =>
{
 config.AddDashboard(dashboard =>
 {
 dashboard.WithHostAuthentication();
 });
});

Use Host Authentication with Custom Policy

services.AddTickerQ<MyTimeTicker, MyCronTicker>(config =>
{
 config.AddDashboard(dashboard =>
 {
 dashboard.WithHostAuthentication("AdminPolicy");
 });
});

Dedicated OpenAPI Group

services.AddTickerQ<MyTimeTicker, MyCronTicker>(config =>
{
 config.AddDashboard(dashboard =>
 {
 dashboard.SetGroupName("tickerq");
 });
});

🔧 Fluent API Methods

• WithBasicAuth(username, password) - Enable username/password authentication
• WithApiKey(apiKey) - Enable API key authentication
• WithHostAuthentication(policy) - Use your app's existing auth with optional policy (e.g., "AdminPolicy")
• SetBasePath(path) - Set dashboard URL path
• SetBackendDomain(domain) - Set backend API domain
• SetCorsPolicy(policy) - Configure CORS
• SetGroupName(name) - Set OpenAPI group name for dashboard endpoints

🔒 How It Works

The dashboard automatically detects your authentication method:

1. No auth configured → Public dashboard
2. Basic auth configured → Username/password login
3. Bearer token configured → API key authentication
4. Host auth configured → Delegates to your app's auth system

🌐 Frontend Integration

The frontend automatically adapts based on your backend configuration:

• Shows appropriate login UI
• Handles SignalR authentication
• Supports both header and query parameter auth (for WebSockets)

That's it! Simple and clean. 🎉