# Keycloak — Pipedream Connect

> Open Source Identity and Access Management.

- API slug: `keycloak` (use in MCP headers and tool keys)
- Auth: OAuth (Pipedream-managed)
- Categories: Infrastructure & Cloud
- Website: https://www.keycloak.org/
- This page (HTML): https://pipedream.com/apps/keycloak
- Tools: 5 actions · 1 trigger

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: keycloak`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "keycloak",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Create User:
const result = await mcp.callTool({
  name: "keycloak-create-user",
  arguments: {
    realm: "Realm",
    username: "Username",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a Keycloak endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
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-create-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    keycloak: { authProvisionId: "apn_xxxxxxx" },
    realm: "Realm",
    username: "Username",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (5)

### `keycloak-create-user` — Create User (Write)

Create a new user in Keycloak. The username must be unique. See the documentation

Full schema: https://pipedream.com/apps/keycloak/actions/create-user.md

### `keycloak-delete-user` — Delete User (Write)

Delete a user from Keycloak. See the documentation

Full schema: https://pipedream.com/apps/keycloak/actions/delete-user.md

### `keycloak-get-user` — Get User (Read-only)

Retrieve the representation of the user. See the documentation

Full schema: https://pipedream.com/apps/keycloak/actions/get-user.md

### `keycloak-list-realm-options` — List Realm Options (Read-only)

Retrieves available options for the Realm field.

Full schema: https://pipedream.com/apps/keycloak/actions/list-realm-options.md

### `keycloak-update-user` — Update User (Write)

Updates a user in Keycloak. See the documentation

Full schema: https://pipedream.com/apps/keycloak/actions/update-user.md

## Triggers (1)

### `keycloak-new-event-created` — New Event Created (Polling)

Emit new event when a new event is created. See the documentation

Full schema: https://pipedream.com/apps/keycloak/triggers/new-event-created.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt