Skip to main content

Authentication Settings

  • EnableGeneral authenticationSecurity: for your project to secure API endpoints.
    • Set JWTAccess secretsToken andExpiry token(e.g., expiry durations1h) to control how long JWT access tokens remain valid.
    • OptionallySet enableRefresh row‑levelToken securityExpiry and(e.g., configure7h) sessionfor lengthsthe validity of refresh tokens.
    • Set Password Token Expiry (e.g., 1h) for “forgot password” links.
    • Define Public Routes (comma-separated API paths) that bypass authentication (e.g., /auth/login, /products). Public routes skip JWT checks but still respect business logic.
  • Tenant Scoping (Row‑Level Security):
    • Enable multi-tenant configuration when multiple users belong to suitan account or when each user should only see their own records.
    • Choose a Tenant Model: select the table representing tenants (e.g., accounts for organization-level apps or users for single-user tenancy).
    • Set the Default Tenant Field Name: column to add for scoping (e.g., account_id or user_id).
    • Exclude Tables: choose tables that should not receive the tenant column (e.g., products, countries, or other global catalogs).
  • Email (SMTP) Settings:
    • Configure your applicationemail requirements.provider’s SMTP Host & Port.
    • Provide emailSMTP (SMTP)Username settings& Password for usersending flowsemails.
    • like
    • Set a From Address (e.g., no-reply@yourdomain.com) and From Name (e.g., Your App).
    • Specify the Base URL where users complete password resets or(e.g., verification emails.https://yourapp.com).
    • DecideDefine ifa rolesPassword Reset Path containing a %s placeholder for the token, such as /reset-password?token=%s.
    • When users request a reset, the API generates a token and permissionssends willan beemail used;linking otherwise{BaseURL}{PasswordResetPath}, endpointsreplacing can%s bewith publiclythe accessible.token.
  • Once configured, these authentication settings secure your API and enable user authentication flows.