Skip to main content

Auth API

Auth routes support dashboard account lifecycle and session management.

Endpoint matrix

Security controls

  • Turnstile verification on selected sensitive flows when configured.
  • Password complexity enforced for credential setup/reset.
  • Account lockout after repeated failed login attempts.
  • CORS allowlist enforcement on auth responses.

Registration and verification behavior

  • Email signup creates user in unverified state.
  • Existing unverified email signup attempts can trigger verification resend.
  • Existing verified email signup is rejected as duplicate.
  • Verification endpoint finalizes account state.

Social auth behavior

  • OAuth callback supports provider-linked login/account linking.
  • Social and credential methods can coexist on one account.
  • Provider unlink is restricted to prevent account lockout scenarios.

Authentication mode

These endpoints are session-oriented account APIs. Use API keys for workspace automation APIs, not account-auth lifecycle routes.

Typical failures

  • 400/422 validation errors
  • 401 UNAUTHORIZED invalid credentials/session
  • 403 FORBIDDEN bot check failure or policy violation
  • 409 USER_EXISTS duplicate verified account
  • lockout-related auth denial after repeated failed attempts
Related docs:
  • /user-guides/manual/workspace/security-and-compliance
  • /user-guides/manual/workspace/settings-and-preferences
  • /user-guides/manual/workspace/settings-and-preferences