View as Markdown
PixieBrix icon

PixieBrix ACTION

Add Group Memberships

Adds user memberships to a group in PixieBrix. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PixieBrix account once, then configure and run Add Group Memberships 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: "pixiebrix-add-group-memberships",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pixiebrix: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization ID",
    groupId: "Group 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.

Add Group Memberships inputs
Property Type Description
organizationId Organization ID string
The ID of the organization
Required Dynamic
groupId Group ID string
The ID of the group
Required Dynamic
userIds User IDs string[]
The IDs or emails of the users to add to the group
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
pixiebrix-add-group-memberships
Version
0.0.2
App
PixieBrix
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes