Clerk

Usage Instructions

Integrate Clerk authentication and user management into your workflow. Create, update, delete, and list users. Manage organizations and their memberships. Monitor and control user sessions.

Tools

`clerk_list_users`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description
`orderBy`	string	No	No description
`emailAddress`	string	No	Filter by email address (e.g., user@example.com or user1@example.com,user2@example.com)
`phoneNumber`	string	No	No description
`externalId`	string	No	No description
`username`	string	No	No description
`userId`	string	No	Filter by user ID (e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC or comma-separated for multiple)
`query`	string	No	Search query to match across email, phone, username, and names (e.g., john or john@example.com)

Output

Parameter	Type	Description
`users`	array	Array of Clerk user objects
↳ `id`	string	User ID
↳ `username`	string	Username
↳ `firstName`	string	First name
↳ `lastName`	string	Last name
↳ `imageUrl`	string	Profile image URL
↳ `hasImage`	boolean	Whether user has a profile image
↳ `primaryEmailAddressId`	string	Primary email address ID
↳ `primaryPhoneNumberId`	string	Primary phone number ID
↳ `emailAddresses`	array	User email addresses
↳ `id`	string	Email address ID
↳ `emailAddress`	string	Email address
↳ `phoneNumbers`	array	User phone numbers
↳ `id`	string	Phone number ID
↳ `phoneNumber`	string	Phone number
↳ `externalId`	string	External system ID
↳ `passwordEnabled`	boolean	Whether password is enabled
↳ `twoFactorEnabled`	boolean	Whether 2FA is enabled
↳ `banned`	boolean	Whether user is banned
↳ `locked`	boolean	Whether user is locked
↳ `lastSignInAt`	number	Last sign-in timestamp
↳ `lastActiveAt`	number	Last activity timestamp
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
↳ `publicMetadata`	json	Public metadata
`totalCount`	number	Total number of users matching the query
`success`	boolean	Operation success status

`clerk_get_user`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	User ID
`username`	string	Username
`firstName`	string	First name
`lastName`	string	Last name
`imageUrl`	string	Profile image URL
`hasImage`	boolean	Whether user has a profile image
`primaryEmailAddressId`	string	Primary email address ID
`primaryPhoneNumberId`	string	Primary phone number ID
`primaryWeb3WalletId`	string	Primary Web3 wallet ID
`emailAddresses`	array	User email addresses
↳ `id`	string	Email address ID
↳ `emailAddress`	string	Email address
↳ `verified`	boolean	Whether email is verified
`phoneNumbers`	array	User phone numbers
↳ `id`	string	Phone number ID
↳ `phoneNumber`	string	Phone number
↳ `verified`	boolean	Whether phone is verified
`externalId`	string	External system ID
`passwordEnabled`	boolean	Whether password is enabled
`twoFactorEnabled`	boolean	Whether 2FA is enabled
`totpEnabled`	boolean	Whether TOTP is enabled
`backupCodeEnabled`	boolean	Whether backup codes are enabled
`banned`	boolean	Whether user is banned
`locked`	boolean	Whether user is locked
`deleteSelfEnabled`	boolean	Whether user can delete themselves
`createOrganizationEnabled`	boolean	Whether user can create organizations
`lastSignInAt`	number	Last sign-in timestamp
`lastActiveAt`	number	Last activity timestamp
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`publicMetadata`	json	Public metadata (readable from frontend)
`privateMetadata`	json	Private metadata (backend only)
`unsafeMetadata`	json	Unsafe metadata (modifiable from frontend)
`success`	boolean	Operation success status

`clerk_create_user`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`emailAddress`	string	No	No description
`phoneNumber`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`firstName`	string	No	No description
`lastName`	string	No	No description
`externalId`	string	No	No description
`publicMetadata`	json	No	No description
`privateMetadata`	json	No	No description
`unsafeMetadata`	json	No	No description
`skipPasswordChecks`	boolean	No	No description
`skipPasswordRequirement`	boolean	No	No description

Output

Parameter	Type	Description
`id`	string	Created user ID
`username`	string	Username
`firstName`	string	First name
`lastName`	string	Last name
`imageUrl`	string	Profile image URL
`primaryEmailAddressId`	string	Primary email address ID
`primaryPhoneNumberId`	string	Primary phone number ID
`emailAddresses`	array	User email addresses
↳ `id`	string	Email address ID
↳ `emailAddress`	string	Email address
↳ `verified`	boolean	Whether email is verified
`phoneNumbers`	array	User phone numbers
↳ `id`	string	Phone number ID
↳ `phoneNumber`	string	Phone number
↳ `verified`	boolean	Whether phone is verified
`externalId`	string	External system ID
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`publicMetadata`	json	Public metadata
`success`	boolean	Operation success status

`clerk_update_user`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`userId`	string	Yes	No description
`firstName`	string	No	No description
`lastName`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`externalId`	string	No	No description
`primaryEmailAddressId`	string	No	No description
`primaryPhoneNumberId`	string	No	No description
`publicMetadata`	json	No	No description
`privateMetadata`	json	No	No description
`unsafeMetadata`	json	No	No description
`skipPasswordChecks`	boolean	No	No description

Output

Parameter	Type	Description
`id`	string	Updated user ID
`username`	string	Username
`firstName`	string	First name
`lastName`	string	Last name
`imageUrl`	string	Profile image URL
`primaryEmailAddressId`	string	Primary email address ID
`primaryPhoneNumberId`	string	Primary phone number ID
`emailAddresses`	array	User email addresses
↳ `id`	string	Email address ID
↳ `emailAddress`	string	Email address
↳ `verified`	boolean	Whether email is verified
`phoneNumbers`	array	User phone numbers
↳ `id`	string	Phone number ID
↳ `phoneNumber`	string	Phone number
↳ `verified`	boolean	Whether phone is verified
`externalId`	string	External system ID
`banned`	boolean	Whether user is banned
`locked`	boolean	Whether user is locked
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`publicMetadata`	json	Public metadata
`success`	boolean	Operation success status

`clerk_delete_user`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	Deleted user ID
`object`	string	Object type (user)
`deleted`	boolean	Whether the user was deleted
`success`	boolean	Operation success status

`clerk_list_organizations`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description
`includeMembersCount`	boolean	No	No description
`query`	string	No	No description
`orderBy`	string	No	No description

Output

Parameter	Type	Description
`organizations`	array	Array of Clerk organization objects
↳ `id`	string	Organization ID
↳ `name`	string	Organization name
↳ `slug`	string	Organization slug
↳ `imageUrl`	string	Organization image URL
↳ `hasImage`	boolean	Whether organization has an image
↳ `membersCount`	number	Number of members
↳ `pendingInvitationsCount`	number	Number of pending invitations
↳ `maxAllowedMemberships`	number	Max allowed memberships
↳ `adminDeleteEnabled`	boolean	Whether admin delete is enabled
↳ `createdBy`	string	Creator user ID
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
↳ `publicMetadata`	json	Public metadata
`totalCount`	number	Total number of organizations
`success`	boolean	Operation success status

`clerk_get_organization`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`organizationId`	string	Yes	The ID or slug of the organization to retrieve (e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug)

Output

Parameter	Type	Description
`id`	string	Organization ID
`name`	string	Organization name
`slug`	string	Organization slug
`imageUrl`	string	Organization image URL
`hasImage`	boolean	Whether organization has an image
`membersCount`	number	Number of members
`pendingInvitationsCount`	number	Number of pending invitations
`maxAllowedMemberships`	number	Max allowed memberships
`adminDeleteEnabled`	boolean	Whether admin delete is enabled
`createdBy`	string	Creator user ID
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`publicMetadata`	json	Public metadata
`success`	boolean	Operation success status

`clerk_create_organization`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`name`	string	Yes	No description
`createdBy`	string	Yes	User ID of the creator who will become admin (e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC)
`slug`	string	No	No description
`maxAllowedMemberships`	number	No	No description
`publicMetadata`	json	No	No description
`privateMetadata`	json	No	No description

Output

Parameter	Type	Description
`id`	string	Created organization ID
`name`	string	Organization name
`slug`	string	Organization slug
`imageUrl`	string	Organization image URL
`hasImage`	boolean	Whether organization has an image
`membersCount`	number	Number of members
`pendingInvitationsCount`	number	Number of pending invitations
`maxAllowedMemberships`	number	Max allowed memberships
`adminDeleteEnabled`	boolean	Whether admin delete is enabled
`createdBy`	string	Creator user ID
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`publicMetadata`	json	Public metadata
`success`	boolean	Operation success status

`clerk_list_sessions`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`userId`	string	No	User ID to list sessions for (e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC; required if clientId not provided)
`clientId`	string	No	No description
`status`	string	No	Filter by session status (abandoned, active, ended, expired, pending, removed, replaced, revoked)
`limit`	number	No	No description
`offset`	number	No	No description

Output

Parameter	Type	Description
`sessions`	array	Array of Clerk session objects
↳ `id`	string	Session ID
↳ `userId`	string	User ID
↳ `clientId`	string	Client ID
↳ `status`	string	Session status
↳ `lastActiveAt`	number	Last activity timestamp
↳ `lastActiveOrganizationId`	string	Last active organization ID
↳ `expireAt`	number	Expiration timestamp
↳ `abandonAt`	number	Abandon timestamp
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
`totalCount`	number	Total number of sessions
`success`	boolean	Operation success status

`clerk_get_session`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`sessionId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	Session ID
`userId`	string	User ID
`clientId`	string	Client ID
`status`	string	Session status
`lastActiveAt`	number	Last activity timestamp
`lastActiveOrganizationId`	string	Last active organization ID
`expireAt`	number	Expiration timestamp
`abandonAt`	number	Abandon timestamp
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`success`	boolean	Operation success status

`clerk_revoke_session`

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`sessionId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	Session ID
`userId`	string	User ID
`clientId`	string	Client ID
`status`	string	Session status (should be revoked)
`lastActiveAt`	number	Last activity timestamp
`lastActiveOrganizationId`	string	Last active organization ID
`expireAt`	number	Expiration timestamp
`abandonAt`	number	Abandon timestamp
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`success`	boolean	Operation success status

Clerk

On this page