View as Markdown
Retool icon

Retool ACTION

Create User

Creates a new user. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Retool 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: "retool-create-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    retool: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    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
email Email string
The email of the user to be created.
Required
firstName First Name string
The first name of the user.
Required
lastName Last Name string
The last name of the user.
Required
active Active boolean
Whether the user should be active. Defaults to true if not provided.
Optional
metadata Metadata object
Additional metadata to associate with the user.
Optional
userType User Type string
The type of the user.
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
retool-create-user
Version
0.0.1
App
Retool
Authentication
API key
Read-only
No
Destructive
No
Idempotent
No
Open world
Yes