Overview
The/settings endpoint returns publicly available authentication settings that can be used by client applications to configure their authentication flows. This endpoint does not require authentication and is safe to call from public clients.
Request
Response
Response Fields
| Field | Type | Description |
|---|---|---|
external_email_enabled | boolean | Whether email/password authentication is enabled |
external_phone_enabled | boolean | Whether phone/SMS authentication is enabled |
external_providers_enabled | boolean | Whether OAuth providers are enabled |
external_providers | array | List of available OAuth providers and their status |
disable_signup | boolean | Whether new user registration is disabled |
autoconfirm | boolean | Whether users are automatically confirmed |
password_min_length | integer | Minimum password length requirement |
password_requirements | object | Password complexity requirements |
email_confirm_required | boolean | Whether email confirmation is required |
phone_confirm_required | boolean | Whether phone confirmation is required |
session_timeout | integer | Session timeout in seconds |
refresh_token_rotation_enabled | boolean | Whether refresh tokens are rotated |
mfa_enabled | boolean | Whether multi-factor authentication is enabled |
mfa_max_enrolled_factors | integer | Maximum MFA factors per user |
rate_limits | object | Rate limiting configuration for different endpoints |
Implementation Examples
React Hook for Settings
Password Validation
Node.js Middleware
Use Cases
Dynamic Form Configuration
Use the settings to dynamically configure your authentication forms:- Show/hide email vs phone authentication options
- Display available OAuth providers
- Configure password requirements
- Show appropriate confirmation messages
Client-Side Validation
Implement client-side validation that matches server-side requirements:- Password complexity validation
- Rate limiting awareness
- Feature availability checks
Progressive Enhancement
Gracefully handle different authentication capabilities:- Fallback to email if phone is disabled
- Hide MFA options if not enabled
- Adjust UI based on confirmation requirements
Security Considerations
- Public Endpoint: This endpoint is intentionally public and doesn’t expose sensitive configuration
- Rate Limiting: Consider caching settings on the client side to avoid excessive requests
- Feature Detection: Use settings to enable/disable features rather than hardcoding capabilities
- Validation Sync: Ensure client-side validation matches the server-side requirements
Related Endpoints
- User Signup - Uses password requirements from settings
- Login - Respects rate limiting configuration
- OAuth Authorization - Uses external provider settings