View as Markdown
Clerk icon

Clerk ACTION

Create User

Creates a new user. Your user management settings determine how you should setup your user model. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Clerk account once, then configure and run Create User from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "clerk-create-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clerk: { authProvisionId: "apn_xxxxxxx" },
    externalId: "External Id",
    firstName: "First Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create User inputs
Property Type Description
externalId External Id string
The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.
Optional
firstName First Name string
The first name to assign to the user.
Optional
lastName Last Name string
The last name to assign to the user.
Optional
emailAddress Email Addresses string[]
Email addresses to add to the user. Must be unique across your instance. The first email address will be set as the user's primary email address.
Required
phoneNumber Phone Numbers string[]
Phone numbers to add to the user. Must be unique across your instance. The first phone number will be set as user's primary phone number.
Optional
web3Wallet Web3 Wallets string[]
Web3 wallets to add to the user. Must be unique across your instance. The first wallet will be set as the user's primary wallet.
Optional
username Username string
The username to give to the user. It must be unique across your instance.
Optional
password Password string
The plaintext password to give to the user. Must be at least 8 characters long, and can not be in any list of hacked passwords.
Required
passwordDigest Password Digest string
In case you already have the password digests and not the passswords, you can use them for the newly created user via this property. The digests should be generated with one of the supported algorithms. The hashing algorithm can be specified using the Password Hasher property.
Optional
passwordHasher Password Hasher string
The hashing algorithm that was used to generate the password digest. The algorithms that Clerk supports at the moment are bcrypt, bcrypt_sha256_django, md5, pbkdf2_sha256, pbkdf2_sha256_django, phpass, scrypt_firebase and 2 argon2 variants, argon2i and argon2id. Each of the above expects the incoming digest to be of a particular format. See the documentation for further information.
Optional
skipPasswordChecks Skip Password Checks boolean
When set to true all password checks are skipped. It is recommended to use this method only when migrating plaintext passwords to Clerk. Upon migration the user base should be prompted to pick stronger password.
Optional
skipPasswordRequirement Skip Password Requirement boolean
When set to true, password is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance.
Optional
totpSecret TOTP Secret string
In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Optional
backupCodes Backup Codes string[]
If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest.
Optional
publicMetadata Public Metadata object
Metadata saved on the user, that is visible to both your Frontend and Backend APIs.
Optional
privateMetadata Private Metadata object
Metadata saved on the user, that is only visible to your Backend API.
Optional
unsafeMetadata Unsafe Metadata object
Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.
Optional
createdAt Created At string
A custom date/time denoting when the user signed up to the application, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
clerk-create-user
Version
0.0.3
App
Clerk
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes