Skip to main content
GET

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

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

Testing