View as Markdown
Keycloak icon

Keycloak ACTION

Delete User

Delete a user from Keycloak. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Keycloak account once, then configure and run Delete 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: "keycloak-delete-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    keycloak: { authProvisionId: "apn_xxxxxxx" },
    realm: "Realm",
    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.

Delete User inputs
Property Type Description
realm Realm string
The realm name (not id) to which the user belongs.
Required Dynamic
userId User ID string
The unique identifier of the user.
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
keycloak-delete-user
Version
0.0.2
App
Keycloak
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes