Admin UI Plugin Management
The Authrim Admin Console provides a graphical interface for managing plugins without writing code or API calls.
Plugin List
Navigate to Settings > Plugins to view all registered plugins.
The plugin list displays:
- Plugin icon and name
- Brief description
- Category badge (notification, identity, authentication, flow)
- Status indicator (enabled/disabled)
- Trust level badge (Official/Community)
Filtering
Use the filter controls to narrow down the list:
| Filter | Options |
|---|---|
| Category | All, Notification, Identity, Authentication, Flow |
| Status | All, Enabled, Disabled |
| Trust Level | All, Official, Community |
Plugin Card
Each plugin card shows:
| Element | Description |
|---|---|
| Icon | Plugin icon (Lucide icon or custom) |
| Name | Display name from metadata |
| Version | Semantic version (e.g., 1.0.0) |
| Description | Short description |
| Category Badge | notification, identity, authentication, or flow |
| Status Badge | Enabled (green) or Disabled (gray) |
| Trust Badge | Official (verified) or Community (warning) |
Click a card to open the detail dialog.
Detail Dialog
The plugin detail dialog provides comprehensive information and controls:
Overview Tab
- Full description
- Author information
- License
- Documentation links (if available)
- Repository link (if available)
- Stability status (stable, beta, alpha, deprecated)
- Tags for search/categorization
Configuration Tab
The configuration form is automatically generated from the plugin’s Zod schema:
| Schema Type | UI Component |
|---|---|
z.string() | Text input |
z.string().url() | URL input with validation |
z.number() | Number input with min/max |
z.boolean() | Toggle switch |
z.enum([...]) | Dropdown select |
| Secret field patterns | Password input (masked) |
Configuration fields show:
- Label (from
.describe()) - Current value
- Default value (if different)
- Validation messages
Health Tab
Displays the plugin’s health check results:
| Status | Indicator | Description |
|---|---|---|
healthy | Green | Plugin functioning normally |
degraded | Yellow | Operational but with issues |
unhealthy | Red | Not functioning |
unknown | Gray | No health data available |
Health check details may include:
- Last check timestamp
- Status message
- Individual check results (API connectivity, credentials, etc.)
Admin Notes
If the plugin provides admin notes, they appear in a collapsible section with:
- Configuration tips
- Known limitations
- Migration instructions
- Deployment notes
Editing Configuration
- Open the plugin detail dialog
- Switch to the Configuration tab
- Modify field values
- Click Save Configuration
Validation
- Real-time validation as you type
- Required field indicators
- Min/max constraints for numbers
- URL format validation
- Custom validation messages
Configuration Sources
The UI indicates where the current configuration comes from:
| Source | Badge | Description |
|---|---|---|
kv | KV Storage | Saved via Admin UI/API |
env | Environment | From environment variables |
default | Default | Schema default values |
Enable/Disable
Enabling a Plugin
- Open the plugin detail dialog
- Click the Enable button
- If configuration is required, complete the form first
- Confirm the action
Disabling a Plugin
- Open the plugin detail dialog
- Click the Disable button
- Review the dependency warning (if applicable)
- Confirm the action
Health Check
Manual Health Check
- Open the plugin detail dialog
- Switch to the Health tab
- Click Run Health Check
- View results
Automatic Health Checks
Health checks run automatically:
- On plugin enable
- Periodically (configurable interval)
- On configuration change
Community Plugin Warning
When viewing a community plugin, a warning banner appears:
Community Plugin
This plugin is provided by a third party. Authrim does not guarantee its security, reliability, or compatibility. Review the source code and use at your own risk.
The warning includes:
- Author information
- Repository link (if available)
- License information
Multi-tenant Configuration
For multi-tenant deployments:
- Select the tenant from the tenant dropdown (top-right)
- View/edit tenant-specific configuration
- Tenant config overrides global settings
Tenant configuration shows:
- Which values are inherited (from global)
- Which values are overridden (tenant-specific)
- Option to reset to global values
Quick Actions
From the plugin list, hover over a card for quick actions:
| Action | Icon | Description |
|---|---|---|
| Toggle | Switch | Enable/disable without opening dialog |
| Configure | Gear | Jump directly to configuration tab |
| Health | Heart | Run health check |
Search
Use the search bar to find plugins by:
- Name
- Description
- Tags
- Category
- Author
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
/ | Focus search |
Esc | Close dialog |
Tab | Navigate fields |
Enter | Submit form |
API Reference
For programmatic access, see the Plugin Management API documentation.
Common operations:
| Task | API Endpoint |
|---|---|
| List plugins | GET /api/admin/plugins |
| Get plugin | GET /api/admin/plugins/:id |
| Update config | PUT /api/admin/plugins/:id/config |
| Enable | PUT /api/admin/plugins/:id/enable |
| Disable | PUT /api/admin/plugins/:id/disable |
| Health check | GET /api/admin/plugins/:id/health |
| Get schema | GET /api/admin/plugins/:id/schema |
Troubleshooting
Plugin Not Appearing
- Check if the plugin is registered in your worker
- Verify the plugin exports correctly
- Check worker logs for registration errors
Configuration Not Saving
- Check validation errors in the form
- Verify you have admin permissions
- Check browser console for API errors
Health Check Failing
- Review the error message
- Check plugin dependencies (external services)
- Verify configuration values (API keys, endpoints)
- Check network connectivity from the worker
Community Plugin Concerns
If you have security concerns about a community plugin:
- Review the source code
- Check the author’s reputation
- Audit dependencies
- Consider running in a test environment first