0

Lock a user

by
Published Apr 8, 2025

Marks the given user as locked, which means they are not allowed to sign in again until the lock expires. Lock duration can be configured in the instance's restrictions settings.

Script clerk Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Clerk = {
3
  apiKey: string;
4
};
5
/**
6
 * Lock a user
7
 * Marks the given user as locked, which means they are not allowed to sign in again until the lock expires.
8
Lock duration can be configured in the instance's restrictions settings.
9
 */
10
export async function main(auth: Clerk, user_id: string) {
11
  const url = new URL(`https://api.clerk.com/v1/users/${user_id}/lock`);
12

13
  const response = await fetch(url, {
14
    method: "POST",
15
    headers: {
16
      Authorization: "Bearer " + auth.apiKey,
17
    },
18
    body: undefined,
19
  });
20
  if (!response.ok) {
21
    const text = await response.text();
22
    throw new Error(`${response.status} ${text}`);
23
  }
24
  return await response.json();
25
}
26