Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions content/docs/references/misc/AuthenticationConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: AuthenticationConfig
description: AuthenticationConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Configuration name (snake_case) |
| **label** | `string` | ✅ | Display label |
| **strategies** | `Enum<'email_password' \| 'magic_link' \| 'oauth' \| 'passkey' \| 'otp' \| 'anonymous'>[]` | ✅ | Enabled authentication strategies |
| **baseUrl** | `string` | ✅ | Application base URL |
| **secret** | `string` | ✅ | Secret key for signing (min 32 chars) |
| **emailPassword** | `object` | optional | |
| **magicLink** | `object` | optional | |
| **passkey** | `object` | optional | |
| **oauth** | `object` | optional | |
| **session** | `object` | optional | |
| **rateLimit** | `object` | optional | |
| **csrf** | `object` | optional | |
| **accountLinking** | `object` | optional | |
| **twoFactor** | `object` | optional | |
| **userFieldMapping** | `object` | optional | |
| **database** | `object` | optional | |
| **plugins** | `object[]` | optional | |
| **hooks** | `object` | optional | Authentication lifecycle hooks |
| **security** | `object` | optional | Advanced security settings |
| **email** | `object` | optional | Email configuration |
| **ui** | `object` | optional | UI customization |
| **active** | `boolean` | optional | Whether this provider is active |
| **allowRegistration** | `boolean` | optional | Allow new user registration |
11 changes: 11 additions & 0 deletions content/docs/references/misc/AuthenticationProvider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: AuthenticationProvider
description: AuthenticationProvider Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `string` | ✅ | Provider type identifier |
| **config** | `object` | ✅ | Authentication configuration |
12 changes: 12 additions & 0 deletions content/docs/references/system/AccountLinkingConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: AccountLinkingConfig
description: AccountLinkingConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | Allow account linking |
| **autoLink** | `boolean` | optional | Automatically link accounts with same email |
| **requireVerification** | `boolean` | optional | Require email verification before linking |
33 changes: 33 additions & 0 deletions content/docs/references/system/AuthConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: AuthConfig
description: AuthConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Configuration name (snake_case) |
| **label** | `string` | ✅ | Display label |
| **driver** | `string` | optional | The underlying authentication implementation driver |
| **strategies** | `Enum<'email_password' \| 'magic_link' \| 'oauth' \| 'passkey' \| 'otp' \| 'anonymous'>[]` | ✅ | Enabled authentication strategies |
| **baseUrl** | `string` | ✅ | Application base URL |
| **secret** | `string` | ✅ | Secret key for signing (min 32 chars) |
| **emailPassword** | `object` | optional | |
| **magicLink** | `object` | optional | |
| **passkey** | `object` | optional | |
| **oauth** | `object` | optional | |
| **session** | `object` | optional | |
| **rateLimit** | `object` | optional | |
| **csrf** | `object` | optional | |
| **accountLinking** | `object` | optional | |
| **twoFactor** | `object` | optional | |
| **userFieldMapping** | `object` | optional | |
| **database** | `object` | optional | |
| **plugins** | `object[]` | optional | |
| **hooks** | `object` | optional | Authentication lifecycle hooks |
| **security** | `object` | optional | Advanced security settings |
| **email** | `object` | optional | Email configuration |
| **ui** | `object` | optional | UI customization |
| **active** | `boolean` | optional | Whether this provider is active |
| **allowRegistration** | `boolean` | optional | Allow new user registration |
12 changes: 12 additions & 0 deletions content/docs/references/system/AuthPluginConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: AuthPluginConfig
description: AuthPluginConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Plugin name |
| **enabled** | `boolean` | optional | |
| **options** | `Record<string, any>` | optional | Plugin-specific options |
13 changes: 13 additions & 0 deletions content/docs/references/system/AuthStrategy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: AuthStrategy
description: AuthStrategy Schema Reference
---

## Allowed Values

* `email_password`
* `magic_link`
* `oauth`
* `passkey`
* `otp`
* `anonymous`
32 changes: 32 additions & 0 deletions content/docs/references/system/AuthenticationConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: AuthenticationConfig
description: AuthenticationConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Configuration name (snake_case) |
| **label** | `string` | ✅ | Display label |
| **strategies** | `Enum<'email_password' \| 'magic_link' \| 'oauth' \| 'passkey' \| 'otp' \| 'anonymous'>[]` | ✅ | Enabled authentication strategies |
| **baseUrl** | `string` | ✅ | Application base URL |
| **secret** | `string` | ✅ | Secret key for signing (min 32 chars) |
| **emailPassword** | `object` | optional | |
| **magicLink** | `object` | optional | |
| **passkey** | `object` | optional | |
| **oauth** | `object` | optional | |
| **session** | `object` | optional | |
| **rateLimit** | `object` | optional | |
| **csrf** | `object` | optional | |
| **accountLinking** | `object` | optional | |
| **twoFactor** | `object` | optional | |
| **userFieldMapping** | `object` | optional | |
| **database** | `object` | optional | |
| **plugins** | `object[]` | optional | |
| **hooks** | `object` | optional | Authentication lifecycle hooks |
| **security** | `object` | optional | Advanced security settings |
| **email** | `object` | optional | Email configuration |
| **ui** | `object` | optional | UI customization |
| **active** | `boolean` | optional | Whether this provider is active |
| **allowRegistration** | `boolean` | optional | Allow new user registration |
11 changes: 11 additions & 0 deletions content/docs/references/system/AuthenticationProvider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: AuthenticationProvider
description: AuthenticationProvider Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `string` | ✅ | Provider type identifier |
| **config** | `object` | ✅ | Authentication configuration |
13 changes: 13 additions & 0 deletions content/docs/references/system/CSRFConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: CSRFConfig
description: CSRFConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **tokenLength** | `number` | optional | CSRF token length |
| **cookieName** | `string` | optional | CSRF cookie name |
| **headerName** | `string` | optional | CSRF header name |
13 changes: 13 additions & 0 deletions content/docs/references/system/DatabaseAdapter.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: DatabaseAdapter
description: DatabaseAdapter Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'prisma' \| 'drizzle' \| 'kysely' \| 'custom'>` | ✅ | Database adapter type |
| **connectionString** | `string` | optional | Database connection string |
| **tablePrefix** | `string` | optional | Prefix for auth tables |
| **schema** | `string` | optional | Database schema name |
15 changes: 15 additions & 0 deletions content/docs/references/system/EmailPasswordConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: EmailPasswordConfig
description: EmailPasswordConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **requireEmailVerification** | `boolean` | optional | Require email verification before login |
| **minPasswordLength** | `number` | optional | Minimum password length |
| **requirePasswordComplexity** | `boolean` | optional | Require uppercase, lowercase, numbers, symbols |
| **allowPasswordReset** | `boolean` | optional | Enable password reset functionality |
| **passwordResetExpiry** | `number` | optional | Password reset token expiry in seconds |
11 changes: 11 additions & 0 deletions content/docs/references/system/MagicLinkConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: MagicLinkConfig
description: MagicLinkConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **expiryTime** | `number` | optional | Magic link expiry time in seconds (default 15 min) |
17 changes: 17 additions & 0 deletions content/docs/references/system/OAuthProvider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: OAuthProvider
description: OAuthProvider Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **provider** | `Enum<'google' \| 'github' \| 'facebook' \| 'twitter' \| 'linkedin' \| 'microsoft' \| 'apple' \| 'discord' \| 'gitlab' \| 'custom'>` | ✅ | OAuth provider type |
| **clientId** | `string` | ✅ | OAuth client ID |
| **clientSecret** | `string` | ✅ | OAuth client secret (typically from ENV) |
| **scopes** | `string[]` | optional | Requested OAuth scopes |
| **redirectUri** | `string` | optional | OAuth callback URL |
| **enabled** | `boolean` | optional | Whether this provider is enabled |
| **displayName** | `string` | optional | Display name for the provider button |
| **icon** | `string` | optional | Icon URL or identifier |
15 changes: 15 additions & 0 deletions content/docs/references/system/PasskeyConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: PasskeyConfig
description: PasskeyConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **rpName** | `string` | ✅ | Relying Party name |
| **rpId** | `string` | optional | Relying Party ID (defaults to domain) |
| **allowedOrigins** | `string[]` | optional | Allowed origins for WebAuthn |
| **userVerification** | `Enum<'required' \| 'preferred' \| 'discouraged'>` | optional | |
| **attestation** | `Enum<'none' \| 'indirect' \| 'direct' \| 'enterprise'>` | optional | |
14 changes: 14 additions & 0 deletions content/docs/references/system/RateLimitConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: RateLimitConfig
description: RateLimitConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **maxAttempts** | `number` | optional | Maximum login attempts |
| **windowMs** | `number` | optional | Time window in milliseconds (default 15 min) |
| **blockDuration** | `number` | optional | Block duration after max attempts in ms |
| **skipSuccessfulRequests** | `boolean` | optional | Only count failed requests |
17 changes: 17 additions & 0 deletions content/docs/references/system/SessionConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: SessionConfig
description: SessionConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **expiresIn** | `number` | optional | Session expiry in seconds (default 7 days) |
| **updateAge** | `number` | optional | Session update interval in seconds (default 1 day) |
| **cookieName** | `string` | optional | Session cookie name |
| **cookieSecure** | `boolean` | optional | Use secure cookies (HTTPS only) |
| **cookieSameSite** | `Enum<'strict' \| 'lax' \| 'none'>` | optional | SameSite cookie attribute |
| **cookieDomain** | `string` | optional | Cookie domain |
| **cookiePath** | `string` | optional | Cookie path |
| **cookieHttpOnly** | `boolean` | optional | HttpOnly cookie attribute |
11 changes: 11 additions & 0 deletions content/docs/references/system/StandardAuthProvider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: StandardAuthProvider
description: StandardAuthProvider Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `string` | ✅ | Provider type identifier |
| **config** | `object` | ✅ | Standard authentication configuration |
13 changes: 13 additions & 0 deletions content/docs/references/system/TwoFactorConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: TwoFactorConfig
description: TwoFactorConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **issuer** | `string` | optional | TOTP issuer name |
| **qrCodeSize** | `number` | optional | QR code size in pixels |
| **backupCodes** | `object` | optional | |
16 changes: 16 additions & 0 deletions content/docs/references/system/UserFieldMapping.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: UserFieldMapping
description: UserFieldMapping Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | optional | User ID field |
| **email** | `string` | optional | Email field |
| **name** | `string` | optional | Name field |
| **image** | `string` | optional | Profile image field |
| **emailVerified** | `string` | optional | Email verification status field |
| **createdAt** | `string` | optional | Created timestamp field |
| **updatedAt** | `string` | optional | Updated timestamp field |
Loading
Loading