Clerk

Clerk integration (Security, Developer Tools). Imported from open-connector.

API key11 toolshttps://api.clerk.com/v1

GET

clerk_list_users

List Clerk users with optional filtering and pagination.

/users

9 parameters

Param	Type	Required	Description
email_address	array	optional	A list of string values used by Clerk filters.
phone_number	array	optional	A list of string values used by Clerk filters.
username	array	optional	A list of string values used by Clerk filters.
user_id	array	optional	A list of string values used by Clerk filters.
external_id	array	optional	A list of string values used by Clerk filters.
query	string	optional	A search query for Clerk users.
order_by	string	optional	The Clerk order field, such as -created_at.
limit	integer	optional	Maximum number of users to return.
offset	integer	optional	Number of users to skip before returning results.

GET

clerk_count_users

Count Clerk users with optional filters.

/users/count

6 parameters

Param	Type	Required	Description
email_address	array	optional	A list of string values used by Clerk filters.
phone_number	array	optional	A list of string values used by Clerk filters.
username	array	optional	A list of string values used by Clerk filters.
user_id	array	optional	A list of string values used by Clerk filters.
external_id	array	optional	A list of string values used by Clerk filters.
query	string	optional	A search query for Clerk users.

GET

clerk_get_user

Retrieve a Clerk user by ID.

/users/{user_id}

1 parameter

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.

POST

clerk_create_user

Create a Clerk user.

/users

18 parameters

Param	Type	Required	Description
email_address	array	optional	Email addresses to add to the new user.
phone_number	array	optional	Phone numbers to add to the new user.
web3_wallet	array	optional	Web3 wallet addresses to add to the new user.
external_id	string	optional	An external ID for the user.
first_name	string	optional	The user's first name.
last_name	string	optional	The user's last name.
username	string	optional	The username attached to the Clerk user.
password	string	optional	The user's password.
password_digest	string	optional	A password digest for the user.
password_hasher	string	optional	The hashing algorithm used for password_digest.
skip_password_checks	boolean	optional	Whether Clerk should skip password validation checks.
skip_password_requirement	boolean	optional	Whether Clerk should allow creating the user without a password.
totp_secret	string	optional	The TOTP secret to add to the user.
backup_codes	array	optional	Backup codes to add to the user.
public_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
private_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
unsafe_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
created_at	string	optional	The RFC3339 datetime to set as the user's creation time.

PATCH

clerk_update_user

Update a Clerk user.

/users/{user_id}

18 parameters

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.
first_name	string	optional	The user's first name.
last_name	string	optional	The user's last name.
primary_email_address_id	string	optional	The primary email address ID.
primary_phone_number_id	string	optional	The primary phone number ID.
primary_web3_wallet_id	string	optional	The primary Web3 wallet ID.
username	string	optional	The username attached to the Clerk user.
password	string	optional	The user's password.
password_digest	string	optional	A password digest for the user.
password_hasher	string	optional	The hashing algorithm used for password_digest.
skip_password_checks	boolean	optional	Whether Clerk should skip password validation checks.
skip_password_requirement	boolean	optional	Whether Clerk should allow the user without a password.
sign_out_of_other_sessions	boolean	optional	Whether Clerk should sign the user out of other sessions.
totp_secret	string	optional	The TOTP secret to add to the user.
backup_codes	array	optional	Backup codes to add to the user.
public_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
private_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
unsafe_metadata	object	optional	Arbitrary Clerk metadata stored on the user.

PATCH

clerk_update_user_metadata

Deep merge metadata for a Clerk user.

/users/{user_id}/metadata

4 parameters

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.
public_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
private_metadata	object	optional	Arbitrary Clerk metadata stored on the user.
unsafe_metadata	object	optional	Arbitrary Clerk metadata stored on the user.

DELETE

clerk_delete_user

Delete a Clerk user.

/users/{user_id}

1 parameter

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.

POST

clerk_ban_user

Ban a Clerk user.

/users/{user_id}/ban

1 parameter

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.

POST

clerk_unban_user

Unban a Clerk user.

/users/{user_id}/unban

1 parameter

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.

POST

clerk_lock_user

Lock a Clerk user.

/users/{user_id}/lock

1 parameter

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.

POST

clerk_unlock_user

Unlock a Clerk user.

/users/{user_id}/unlock

1 parameter

Param	Type	Required	Description
user_id	string	required	The Clerk user ID.