User Profiles

User Profiles represent the identity of users within a cPod tenant. Each authenticated user has exactly one profile per tenant. Profiles store display information, preferences, and organization memberships with associated roles.

UserProfile Schema

Field	Type	Required	Description
`id`	`string`	auto	Prefixed ID: `usr-{ulid}`
`email`	`string`	auto	Primary email (from identity provider)
`displayName`	`string`	yes	Name shown in the UI
`avatarUrl`	`string`	no	URL of the user’s avatar image
`role`	`enum`	yes	`owner` \| `admin` \| `member` \| `viewer`
`status`	`enum`	auto	`active` \| `suspended` \| `deactivated`
`organizationId`	`string`	auto	Organization this profile belongs to
`preferences.theme`	`enum`	no	`light` \| `dark` \| `system`
`preferences.locale`	`string`	no	BCP 47 locale tag (e.g. `en-US`)
`preferences.notificationsEnabled`	`boolean`	no	Whether email notifications are active
`createdAt`	`string`	auto	ISO 8601 UTC
`updatedAt`	`string`	auto	ISO 8601 UTC

Get Your Own Profile

Retrieve the profile of the currently authenticated user.

import { CpodClient } from '@cpod/sdk'
const sdk = CpodClient.fromEnv()
 
const me = await sdk.userProfiles.me()
console.log(me.id, me.displayName, me.role)
// → "usr-01HXYZ..." "Alice Chen" "admin"

from cpod import CpodClient
sdk = CpodClient.from_env()
 
me = await sdk.user_profiles.me()
print(me.id, me.display_name, me.role)
# → "usr-01HXYZ..." "Alice Chen" "admin"

import "github.com/cpod-ai/cpod-sdk-go/userprofiles"
 
client := cpod.New(os.Getenv("CPOD_API_KEY"))
 
me, err := client.UserProfiles.Me(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(me.ID, me.DisplayName, me.Role)

Get a User Profile

Retrieve a specific user profile by ID. The caller must share an organization with the target user, or be an admin.

const profile = await sdk.userProfiles.get('usr-001')
console.log(profile.email, profile.status)

profile = await sdk.user_profiles.get("usr-001")
print(profile.email, profile.status)

profile, err := client.UserProfiles.Get(ctx, "usr-001")
fmt.Println(profile.Email, profile.Status)

Update Your Profile

Users may update their own displayName, avatarUrl, and preferences. Admins may update any member’s profile.

const updated = await sdk.userProfiles.update('usr-001', {
  displayName: 'Alice C.',
  avatarUrl: 'https://cdn.acme.com/avatars/alice.png',
  preferences: {
    theme: 'dark',
    locale: 'en-US',
    notificationsEnabled: true,
  },
})

updated = await sdk.user_profiles.update(
    "usr-001",
    display_name="Alice C.",
    avatar_url="https://cdn.acme.com/avatars/alice.png",
    preferences={
        "theme": "dark",
        "locale": "en-US",
        "notifications_enabled": True,
    },
)

updated, err := client.UserProfiles.Update(ctx, "usr-001", userprofiles.UpdateInput{
    DisplayName: "Alice C.",
    AvatarURL:   "https://cdn.acme.com/avatars/alice.png",
    Preferences: &userprofiles.Preferences{
        Theme:                "dark",
        Locale:               "en-US",
        NotificationsEnabled: true,
    },
})

List Organization Members

List all user profiles that are members of a given organization. Supports filtering by role and status.

// List all admin members of an organization
const result = await sdk.userProfiles.listMembers('org-001', {
  role: 'admin',
  status: 'active',
  limit: 50,
})
 
for (const member of result.items) {
  console.log(member.id, member.displayName, member.role)
}

result = await sdk.user_profiles.list_members(
    "org-001",
    role="admin",
    status="active",
    limit=50,
)
 
for member in result.items:
    print(member.id, member.display_name, member.role)

result, err := client.UserProfiles.ListMembers(ctx, "org-001", userprofiles.ListMembersOptions{
    Role:   "admin",
    Status: "active",
    Limit:  50,
})
for _, m := range result.Items {
    fmt.Println(m.ID, m.DisplayName, m.Role)
}

Update a Member’s Role

Promote, demote, or suspend a user’s membership in an organization. Requires admin or owner role.

// Promote a member to admin
const updated = await sdk.userProfiles.updateMembership('org-001', 'usr-002', {
  role: 'admin',
})
 
// Suspend a member
await sdk.userProfiles.updateMembership('org-001', 'usr-003', {
  status: 'suspended',
})

# Promote a member to admin
updated = await sdk.user_profiles.update_membership(
    "org-001", "usr-002", role="admin"
)
 
# Suspend a member
await sdk.user_profiles.update_membership(
    "org-001", "usr-003", status="suspended"
)

// Promote a member to admin
updated, err := client.UserProfiles.UpdateMembership(ctx, "org-001", "usr-002",
    userprofiles.UpdateMembershipInput{Role: "admin"},
)
 
// Suspend a member
_, err = client.UserProfiles.UpdateMembership(ctx, "org-001", "usr-003",
    userprofiles.UpdateMembershipInput{Status: "suspended"},
)

Remove a Member

Remove a user from an organization. The user’s profile is not deleted — they simply lose access to that organization’s resources.

⚠️

Owners cannot remove themselves. Transfer ownership before removing yourself.

await sdk.userProfiles.removeMember('org-001', 'usr-003')

await sdk.user_profiles.remove_member("org-001", "usr-003")

err = client.UserProfiles.RemoveMember(ctx, "org-001", "usr-003")

Organizations Credentials