Members

Overview

The Confident AI SDK exposes every Member method on the platform. This page documents how to call these methods in all supported languages. See the introduction to install the SDK and set your API key.

Methods

List Members

Lists your organization's members one page at a time. Membership here is what grants access to the organization itself, so every project's member list is drawn from this one.

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.organization.list_members(page=1, page_size=25)

result = await client.organization.a_list_members(...)

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.organization.listMembers(
  { page: 1, pageSize: 25 },
);

Returns

This method returns an object of type OrganizationMemberList.

Update Member Role

Replaces a member's organization role, which changes what they may do from their next request onwards. Assigning the Owner role transfers ownership: the member becomes Owner and the previous Owner is demoted to Admin in the same transaction. That is the only way the Owner's role changes — moving the Owner onto another role directly is refused. The member's project roles are left untouched.

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.organization.update_member_role(
    user_id="<USER-ID>",
    role_id="<ROLE-ID>",
)

result = await client.organization.a_update_member_role(...)

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.organization.updateMemberRole(
  "<USER-ID>",
  "<ROLE-ID>",
);

Returns

This method returns an object of type OrganizationMember.

Remove Member

Revokes a member's access to the organization and everything inside it: they are detached from every project, their organization and project roles are deleted, and any outstanding invitation for their email is cleared. The Owner cannot be removed, so transfer ownership first. The only way back is a fresh invitation, which returns them with no project access. Their account and the records they created are kept.

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.organization.remove_member(user_id="<USER-ID>")

result = await client.organization.a_remove_member(...)

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.organization.removeMember("<USER-ID>");

Returns

This method returns an object of type MemberRef.

Types

MemberRef

Confirmation that the user is no longer a member. Removing an organization member also removes them from every project in it; removing a project member leaves their organization membership untouched.

class MemberRef:
    id: str

interface MemberRef {
  id: string;
}

MemberRole

The role a member holds, as referenced from the member. Retrieve the role by id from the roles endpoint of the same scope to see the policies behind it.

class MemberRole:
    id: str
    name: str

interface MemberRole {
  id: string;
  name: string;
}

OrganizationMember

A user who belongs to your organization, with the role that decides what they can do in it. Organization membership alone grants no access to any project's data.

class OrganizationMember:
    id: str
    email: str
    name: Optional[str]
    image: Optional[str]
    organization_role: Optional[MemberRole] = Field(alias="organizationRole")

interface OrganizationMember {
  id: string;
  email: string;
  name: string | null;
  image: string | null;
  organizationRole: MemberRole | null;
}

OrganizationMemberList

One page of organization members, with the total across all pages.

class OrganizationMemberList:
    members: List[OrganizationMember]
    total_organization_members: int = Field(alias="totalOrganizationMembers")
    page: int
    page_size: int = Field(alias="pageSize")

interface OrganizationMemberList {
  members: OrganizationMember[];
  totalOrganizationMembers: number;
  page: number;
  pageSize: number;
}

Last updated on September 30, 2026