Skip to main content
GET
/
api
/
auth
/
config
Get authentication configuration
curl --request GET \
  --url https://api.example.com/api/auth/config \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requireEmailVerification": true,
  "passwordMinLength": 66,
  "requireNumber": true,
  "requireLowercase": true,
  "requireUppercase": true,
  "requireSpecialChar": true,
  "verifyEmailRedirectTo": "<string>",
  "resetPasswordRedirectTo": "<string>",
  "verifyEmailMethod": "code",
  "resetPasswordMethod": "code",
  "signInRedirectTo": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Authentication configuration

​
id
string<uuid>
​
requireEmailVerification
boolean
​
passwordMinLength
integer
Required range: 4 <= x <= 128
​
requireNumber
boolean
​
requireLowercase
boolean
​
requireUppercase
boolean
​
requireSpecialChar
boolean
​
verifyEmailRedirectTo
string | null

URL to redirect users after successful email verification (if not set, shows default success page)

​
resetPasswordRedirectTo
string | null

URL to redirect users after successful password reset (if not set, shows default success page)

​
verifyEmailMethod
enum<string>

Method for email verification (code = 6-digit OTP, link = magic link)

Available options:
code,
link
​
resetPasswordMethod
enum<string>

Method for password reset (code = 6-digit OTP + exchange flow, link = magic link)

Available options:
code,
link
​
signInRedirectTo
string | null

URL to redirect users after successful sign in

​
createdAt
string<date-time>
​
updatedAt
string<date-time>