Groups

The Groups domain stores Group entities: teams, departments, distribution lists, security groups, and any logical collection of people. Groups support nested membership — a group can contain both people and other groups.

Group Schema

Field	Type	Required	Description
`id`	`string`	auto	Prefixed ID: `grp-{ulid}`
`name`	`string`	yes	Display name — unique per tenant
`type`	`enum`	yes	`team` \| `department` \| `security` \| `distribution` \| `custom`
`description`	`string`	no	Free-text description
`ownerId`	`string`	no	`id` of an owning `Person`
`parentId`	`string`	no	`id` of a parent `Group` (for nested groups)
`memberCount`	`number`	auto	Computed count of direct members
`tags`	`string[]`	no	Free-form tags
`createdAt`	`string`	auto	ISO 8601 UTC
`updatedAt`	`string`	auto	ISO 8601 UTC

List & Get Groups

import { CpodClient } from '@cpod/sdk'
const sdk = CpodClient.fromEnv()
 
// List all security groups
const result = await sdk.groups.list({ type: 'security', limit: 50 })
 
// Get a single group with its members expanded
const group = await sdk.groups.get('grp-abc123', { expand: ['members'] })
// group.members → Array of { id, type, entity: Person | Group }

from cpod import CpodClient
sdk = CpodClient.from_env()
 
result = await sdk.groups.list(type="security", limit=50)
 
group = await sdk.groups.get("grp-abc123", expand=["members"])

import "github.com/cpod-ai/cpod-sdk-go/groups"
 
client := cpod.New(os.Getenv("CPOD_API_KEY"))
 
result, err := client.Groups.List(ctx, groups.ListOptions{Type: "security", Limit: 50})
 
group, err := client.Groups.Get(ctx, "grp-abc123", &groups.GetOptions{
    Expand: []string{"members"},
})

Create & Update a Group

const group = await sdk.groups.create({
  name: 'Platform Engineering',
  type: 'team',
  description: 'Responsible for internal developer tooling and infrastructure.',
  ownerId: 'per-abc123',
})
 
await sdk.groups.update('grp-abc123', { description: 'Platform & SRE team.' })

group = await sdk.groups.create(
    name="Platform Engineering",
    type="team",
    description="Responsible for internal developer tooling.",
    owner_id="per-abc123",
)
 
await sdk.groups.update("grp-abc123", description="Platform & SRE team.")

group, err := client.Groups.Create(ctx, groups.CreateInput{
    Name:        "Platform Engineering",
    Type:        "team",
    Description: "Internal developer tooling.",
    OwnerID:     "per-abc123",
})
 
_, err = client.Groups.Update(ctx, "grp-abc123", groups.UpdateInput{
    Description: "Platform & SRE team.",
})

Manage Membership

Add and remove members individually, or replace the entire membership set in one call.

// Add members (people or nested groups)
await sdk.groups.addMembers('grp-abc123', [
  { id: 'per-111', type: 'person' },
  { id: 'per-222', type: 'person' },
  { id: 'grp-child', type: 'group' },
])
 
// Remove a member
await sdk.groups.removeMembers('grp-abc123', ['per-111'])
 
// Replace all members atomically
await sdk.groups.setMembers('grp-abc123', [
  { id: 'per-333', type: 'person' },
  { id: 'per-444', type: 'person' },
])
 
// List current members (paginated)
const members = await sdk.groups.listMembers('grp-abc123', { limit: 100 })
for (const m of members.items) {
  console.log(m.id, m.type)
}

await sdk.groups.add_members("grp-abc123", [
    {"id": "per-111", "type": "person"},
    {"id": "per-222", "type": "person"},
])
 
await sdk.groups.remove_members("grp-abc123", ["per-111"])
 
await sdk.groups.set_members("grp-abc123", [
    {"id": "per-333", "type": "person"},
])
 
members = await sdk.groups.list_members("grp-abc123", limit=100)

err = client.Groups.AddMembers(ctx, "grp-abc123", []groups.MemberRef{
    {ID: "per-111", Type: "person"},
    {ID: "per-222", Type: "person"},
})
 
err = client.Groups.RemoveMembers(ctx, "grp-abc123", []string{"per-111"})
 
err = client.Groups.SetMembers(ctx, "grp-abc123", []groups.MemberRef{
    {ID: "per-333", Type: "person"},
})
 
members, err := client.Groups.ListMembers(ctx, "grp-abc123", 100, "")

Delete a Group

⚠️

Deleting a group does not delete its members. Member Person and Group entities are unaffected. Only the group entity itself and its membership edges are removed.

await sdk.groups.delete('grp-abc123')

await sdk.groups.delete("grp-abc123")

err = client.Groups.Delete(ctx, "grp-abc123")

People Technology