View as Markdown
Hex icon

Hex ACTION

Deactivate User

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

IMPLEMENTATION

Call this tool

Connect a user's Hex account once, then configure and run Deactivate 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: "hex-deactivate-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hex: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
  },
})

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.

Deactivate User inputs
Property Type Description
userId User ID string
The ID of the user to deactivate.
Required Dynamic

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
hex-deactivate-user
Version
0.0.1
App
Hex
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes