From 7e961dcfbf21f32a0b3ea3c477a6c101868d273f Mon Sep 17 00:00:00 2001 From: Michael Novotny Date: Tue, 29 Sep 2026 11:16:13 -0500 Subject: [PATCH] docs(backend): link lockUser() JSDoc to the current Protect rules page Co-Authored-By: Claude Fable 5.1 --- .changeset/lock-user-protect-rules-link.md | 5 +++++ packages/backend/src/api/endpoints/UserApi.ts | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .changeset/lock-user-protect-rules-link.md diff --git a/.changeset/lock-user-protect-rules-link.md b/.changeset/lock-user-protect-rules-link.md new file mode 100644 index 00000000000..e00263cf285 --- /dev/null +++ b/.changeset/lock-user-protect-rules-link.md @@ -0,0 +1,5 @@ +--- +'@clerk/backend': patch +--- + +Update the `lockUser()` JSDoc to link the Dashboard's current Protect rules page. diff --git a/packages/backend/src/api/endpoints/UserApi.ts b/packages/backend/src/api/endpoints/UserApi.ts index 4e7256c525d..28f2b134078 100644 --- a/packages/backend/src/api/endpoints/UserApi.ts +++ b/packages/backend/src/api/endpoints/UserApi.ts @@ -789,7 +789,7 @@ export class UserAPI extends AbstractAPI { } /** - * Locks the given [`User`](https://clerk.com/docs/reference/backend/types/backend-user), which means that they are not allowed to sign in again until the lock expires or is manually unlocked. By default, lockout duration is 1 hour, but it can be configured in the application's [**System**](https://dashboard.clerk.com/~/protect/rules/system) settings under **Protect** > **Rules**. See the [guide on user locks](https://clerk.com/docs/guides/secure/user-lockout). + * Locks the given [`User`](https://clerk.com/docs/reference/backend/types/backend-user), which means that they are not allowed to sign in again until the lock expires or is manually unlocked. By default, lockout duration is 1 hour, but it can be configured in the application's [**System**](https://dashboard.clerk.com/~/protect/rules) settings under **Protect** > **Rules**. See the [guide on user locks](https://clerk.com/docs/guides/secure/user-lockout). * @param userId - The ID of the user to lock. */ public async lockUser(userId: string) {