Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add legalAcceptedAt and skipLegalChecks fields to user management methods #1828

Merged
merged 6 commits into from
Dec 19, 2024
Merged
7 changes: 7 additions & 0 deletions docs/references/backend/types/backend-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Properties>

[web3-ref]: /docs/references/javascript/web3-wallet/web3-wallet
Expand Down
17 changes: 16 additions & 1 deletion docs/references/backend/user/create-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,20 @@ function createUser(params: CreateUserParams): Promise<User>

---

- `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`

Expand Down Expand Up @@ -259,7 +273,8 @@ _User {
externalAccounts: [],
samlAccounts: [],
lastActiveAt: null,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
}
*/
```
Expand Down
6 changes: 4 additions & 2 deletions docs/references/backend/user/get-user-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ console.log(response)
web3Wallets: [],
externalAccounts: [Array],
lastActiveAt: 1707523200000,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
},
_User {
id: 'user_456',
Expand Down Expand Up @@ -170,7 +171,8 @@ console.log(response)
web3Wallets: [],
externalAccounts: [Array],
lastActiveAt: 1707523200000,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
},
...
],
Expand Down
3 changes: 2 additions & 1 deletion docs/references/backend/user/get-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ _User {
web3Wallets: [],
externalAccounts: [],
lastActiveAt: null,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
}
*/
```
Expand Down
17 changes: 16 additions & 1 deletion docs/references/backend/user/update-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,20 @@ function updateUser(userId: string, params: UpdateUserParams): Promise<User>

---

- `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`

Expand Down Expand Up @@ -257,7 +271,8 @@ _User {
],
samlAccounts: [],
lastActiveAt: 1720205704451,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
}
*/
```
Expand Down
2 changes: 1 addition & 1 deletion docs/references/javascript/user/user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
Loading