Salesforce ACTION
Create User
Create a Salesforce user (a login for a person in your org). Requires an available user license and a unique
Username in email form; the Username must be globally unique across all Salesforce orgs. Use Get User or Find Records on User to check whether the person already has an account. See the documentation- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Salesforce 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: "salesforce_rest_api-create-user",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
Alias: "Alias",
CommunityNickname: "Nickname",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "salesforce_rest_api-create-user",
"configured_props": {
"salesforce_rest_api": { "authProvisionId": "apn_xxxxxxx" },
"Alias": "Alias",
"CommunityNickname": "Nickname"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "salesforce_rest_api",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "salesforce_rest_api-create-user",
arguments: {
Alias: "Alias",
CommunityNickname: "Nickname",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
Alias Alias | string | The user's alias (max 8 characters). Required |
CommunityNickname Nickname | string | Name used to identify this user in the Experience Cloud site. Required |
DigestFrequency Chatter Email Highlights Frequency | string | The send frequency of the user's Chatter personal email digest. Required |
Email Email | string | The user's email address. Required |
EmailEncodingKey Email Encoding | string | The email encoding for the user. Required |
LanguageLocaleKey Language | string | The user's language. Required |
LastName Last Name | string | The user's last name. Required |
LocaleSidKey Locale | string | The locale affects formatting and parsing of values, especially numeric values, in the user interface. Required |
ProfileId Profile ID | string | ID of the user's Profile (Salesforce's 15- or 18-character record ID, e.g. 00eXX000001SvR2). Use SOQL Query to find the Profile ID. Required |
TimeZoneSidKey Time Zone | string | A User time zone affects the offset used when displaying or entering times in the user interface. Required |
Username Username | string | Contains the name that a user enters to log in to the API or the user interface. The value for this field must be in the form of an email address, using all lowercase characters. It must also be unique across all organizations. Required |
UserPermissionsMarketingUser Marketing User | boolean | Indicates whether the user is enabled to manage campaigns in the user interface (true) or not (false). Required |
UserPermissionsOfflineUser Offline User | boolean | Indicates whether the user is enabled to use Offline Edition (true) or not (false). Required |
additionalFields Additional Fields | object | Other fields to set for this record as name -> value pairs. Values are parsed as JSON where applicable. Example: {"Industry": "Technology", "AnnualRevenue": 1000000}. Use Describe Object to discover valid field names. 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
- salesforce_rest_api-create-user
- Version
- 0.1.9
- App
- Salesforce
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗