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
23 changes: 23 additions & 0 deletions content/docs/references/system/Account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Account
description: Account Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique account identifier |
| **userId** | `string` | ✅ | Associated user ID |
| **type** | `Enum<'oauth' \| 'oidc' \| 'email' \| 'credentials' \| 'saml' \| 'ldap'>` | ✅ | Account type |
| **provider** | `string` | ✅ | Provider name |
| **providerAccountId** | `string` | ✅ | Provider account ID |
| **refreshToken** | `string` | optional | OAuth refresh token |
| **accessToken** | `string` | optional | OAuth access token |
| **expiresAt** | `number` | optional | Token expiry timestamp (Unix) |
| **tokenType** | `string` | optional | OAuth token type |
| **scope** | `string` | optional | OAuth scope |
| **idToken** | `string` | optional | OAuth ID token |
| **sessionState** | `string` | optional | Session state |
| **createdAt** | `string` | ✅ | Account creation timestamp |
| **updatedAt** | `string` | ✅ | Last update timestamp |
2 changes: 2 additions & 0 deletions content/docs/references/system/AuthConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ description: AuthConfig Schema Reference
| **csrf** | `object` | optional | |
| **accountLinking** | `object` | optional | |
| **twoFactor** | `object` | optional | |
| **enterprise** | `object` | optional | |
| **userFieldMapping** | `object` | optional | |
| **database** | `object` | optional | |
| **mapping** | `object` | optional | |
| **plugins** | `object[]` | optional | |
| **hooks** | `object` | optional | Authentication lifecycle hooks |
| **security** | `object` | optional | Advanced security settings |
Expand Down
13 changes: 13 additions & 0 deletions content/docs/references/system/DatabaseMapping.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: DatabaseMapping
description: DatabaseMapping Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **user** | `Record<string, string>` | optional | User field mapping (e.g., `{ "emailVerified": "email_verified" }`) |
| **session** | `Record<string, string>` | optional | Session field mapping |
| **account** | `Record<string, string>` | optional | Account field mapping |
| **verificationToken** | `Record<string, string>` | optional | VerificationToken field mapping |
12 changes: 12 additions & 0 deletions content/docs/references/system/EnterpriseAuthConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: EnterpriseAuthConfig
description: EnterpriseAuthConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **oidc** | `object` | optional | OpenID Connect configuration |
| **saml** | `object` | optional | SAML 2.0 configuration |
| **ldap** | `object` | optional | LDAP/Active Directory configuration |
18 changes: 18 additions & 0 deletions content/docs/references/system/Session.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Session
description: Session Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique session identifier |
| **sessionToken** | `string` | ✅ | Session token |
| **userId** | `string` | ✅ | Associated user ID |
| **expires** | `string` | ✅ | Session expiry timestamp |
| **createdAt** | `string` | ✅ | Session creation timestamp |
| **updatedAt** | `string` | ✅ | Last update timestamp |
| **ipAddress** | `string` | optional | IP address |
| **userAgent** | `string` | optional | User agent string |
| **fingerprint** | `string` | optional | Device fingerprint |
16 changes: 16 additions & 0 deletions content/docs/references/system/User.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: User
description: User Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique user identifier |
| **email** | `string` | ✅ | User email address |
| **emailVerified** | `boolean` | optional | Whether email is verified |
| **name** | `string` | optional | User display name |
| **image** | `string` | optional | Profile image URL |
| **createdAt** | `string` | ✅ | Account creation timestamp |
| **updatedAt** | `string` | ✅ | Last update timestamp |
13 changes: 13 additions & 0 deletions content/docs/references/system/VerificationToken.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: VerificationToken
description: VerificationToken Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **identifier** | `string` | ✅ | Token identifier (email or phone) |
| **token** | `string` | ✅ | Verification token |
| **expires** | `string` | ✅ | Token expiry timestamp |
| **createdAt** | `string` | ✅ | Token creation timestamp |
13 changes: 8 additions & 5 deletions content/docs/references/system/identity/LDAPConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ description: LDAPConfig Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **url** | `string` | ✅ | LDAP Server URL (ldap:// or ldaps://) |
| **bindDn** | `string` | ✅ | |
| **bindCredentials** | `string` | ✅ | |
| **searchBase** | `string` | ✅ | |
| **searchFilter** | `string` | ✅ | |
| **groupSearchBase** | `string` | optional | |
| **bindDn** | `string` | ✅ | Bind DN for LDAP authentication |
| **bindCredentials** | `string` | ✅ | Bind credentials |
| **searchBase** | `string` | ✅ | Search base DN |
| **searchFilter** | `string` | ✅ | Search filter |
| **groupSearchBase** | `string` | optional | Group search base DN |
| **displayName** | `string` | optional | Display name for the provider button |
| **icon** | `string` | optional | Icon URL or identifier |
9 changes: 6 additions & 3 deletions content/docs/references/system/identity/OIDCConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ description: OIDCConfig Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **issuer** | `string` | ✅ | OIDC Issuer URL (.well-known/openid-configuration) |
| **clientId** | `string` | ✅ | |
| **clientSecret** | `string` | ✅ | |
| **scopes** | `string[]` | optional | |
| **clientId** | `string` | ✅ | OIDC client ID |
| **clientSecret** | `string` | ✅ | OIDC client secret |
| **scopes** | `string[]` | optional | OIDC scopes |
| **attributeMapping** | `Record<string, string>` | optional | Map IdP claims to User fields |
| **displayName** | `string` | optional | Display name for the provider button |
| **icon** | `string` | optional | Icon URL or identifier |
9 changes: 6 additions & 3 deletions content/docs/references/system/identity/SAMLConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ description: SAMLConfig Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **enabled** | `boolean` | optional | |
| **entryPoint** | `string` | ✅ | IdP SSO URL |
| **cert** | `string` | ✅ | IdP Public Certificate |
| **cert** | `string` | ✅ | IdP Public Certificate (PEM format) |
| **issuer** | `string` | ✅ | Entity ID of the IdP |
| **signatureAlgorithm** | `Enum<'sha256' \| 'sha512'>` | optional | |
| **attributeMapping** | `Record<string, string>` | optional | |
| **signatureAlgorithm** | `Enum<'sha256' \| 'sha512'>` | optional | Signature algorithm |
| **attributeMapping** | `Record<string, string>` | optional | Map SAML attributes to User fields |
| **displayName** | `string` | optional | Display name for the provider button |
| **icon** | `string` | optional | Icon URL or identifier |
Loading
Loading