diff --git a/docs/references/backend/types/backend-user.mdx b/docs/references/backend/types/backend-user.mdx index dafe26a73a..70fb019b9e 100644 --- a/docs/references/backend/types/backend-user.mdx +++ b/docs/references/backend/types/backend-user.mdx @@ -208,6 +208,13 @@ The Backend `User` object is similar to the `User` object as it holds informatio - `number` An integer indicating the number of organizations that can be created by the user. If the value is `0`, then the user can create unlimited organizations. Default is `null`. + + --- + + - `legalAcceptedAt?` + - `number | null` + + The unix timestamp of when the user accepted the legal requirements. `null` if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled. [web3-ref]: /docs/references/javascript/web3-wallet/web3-wallet diff --git a/docs/references/backend/user/create-user.mdx b/docs/references/backend/user/create-user.mdx index 1da75cca6f..d912e6615b 100644 --- a/docs/references/backend/user/create-user.mdx +++ b/docs/references/backend/user/create-user.mdx @@ -201,6 +201,20 @@ function createUser(params: CreateUserParams): Promise --- + - `legalAcceptedAt?` + - `Date` + + The date when the user accepted the legal documents. `null` if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled. + + --- + + - `skipLegalChecks?` + - `boolean` + + When set to `true` all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk. + + --- + - `createdAt` - `string` @@ -259,7 +273,8 @@ _User { externalAccounts: [], samlAccounts: [], lastActiveAt: null, - createOrganizationEnabled: true + createOrganizationEnabled: true, + legalAcceptedAt: null } */ ``` diff --git a/docs/references/backend/user/get-user-list.mdx b/docs/references/backend/user/get-user-list.mdx index 8d9864e8bc..b0de35638e 100644 --- a/docs/references/backend/user/get-user-list.mdx +++ b/docs/references/backend/user/get-user-list.mdx @@ -140,7 +140,8 @@ console.log(response) web3Wallets: [], externalAccounts: [Array], lastActiveAt: 1707523200000, - createOrganizationEnabled: true + createOrganizationEnabled: true, + legalAcceptedAt: null }, _User { id: 'user_456', @@ -170,7 +171,8 @@ console.log(response) web3Wallets: [], externalAccounts: [Array], lastActiveAt: 1707523200000, - createOrganizationEnabled: true + createOrganizationEnabled: true, + legalAcceptedAt: null }, ... ], diff --git a/docs/references/backend/user/get-user.mdx b/docs/references/backend/user/get-user.mdx index 4122ea8d16..166b6a44e5 100644 --- a/docs/references/backend/user/get-user.mdx +++ b/docs/references/backend/user/get-user.mdx @@ -67,7 +67,8 @@ _User { web3Wallets: [], externalAccounts: [], lastActiveAt: null, - createOrganizationEnabled: true + createOrganizationEnabled: true, + legalAcceptedAt: null } */ ``` diff --git a/docs/references/backend/user/update-user.mdx b/docs/references/backend/user/update-user.mdx index b146c6f9cd..4675846a50 100644 --- a/docs/references/backend/user/update-user.mdx +++ b/docs/references/backend/user/update-user.mdx @@ -186,6 +186,20 @@ function updateUser(userId: string, params: UpdateUserParams): Promise --- + - `legalAcceptedAt?` + - `Date` + + The date when the user accepted the legal documents. `null` if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled. + + --- + + - `skipLegalChecks?` + - `boolean` + + When set to `true` all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk. + + --- + - `createdAt?` - `Date` @@ -257,7 +271,8 @@ _User { ], samlAccounts: [], lastActiveAt: 1720205704451, - createOrganizationEnabled: true + createOrganizationEnabled: true, + legalAcceptedAt: null } */ ``` diff --git a/docs/references/javascript/user/user.mdx b/docs/references/javascript/user/user.mdx index e536085839..69b3927afa 100644 --- a/docs/references/javascript/user/user.mdx +++ b/docs/references/javascript/user/user.mdx @@ -255,7 +255,7 @@ The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to - `legalAcceptedAt` - `Date` - Date when the user accepted the legal documents. May be empty if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled. + The date when the user accepted the legal documents. `null` if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled. ---