SDKsTypeScript SDKType Reference
Organization Types
TypeScript type definitions for Organization, Member, and Invitation.
Organization Types
Organization
interface Organization {
id: string;
name: string;
slug: string;
domains: string[];
registrationMode: "open" | "invite_only" | "sso_only" | "disabled";
memberCount: number;
ssoEnabled: boolean;
scimEnabled: boolean;
branding: OrganizationBranding | null;
metadata: Record<string, unknown>;
createdAt: string;
updatedAt: string;
}OrganizationBranding
interface OrganizationBranding {
logoUrl: string | null;
faviconUrl: string | null;
primaryColor: string | null; // Hex color (e.g., "#0F62FE")
accentColor: string | null;
customCss: string | null; // Custom CSS for login pages
}Member
interface Member {
userId: string;
email: string;
name: { first: string; last: string } | null;
role: "owner" | "admin" | "member" | "viewer" | "billing";
joinedAt: string;
lastActiveAt: string | null;
}MemberList
interface MemberList {
members: Member[];
nextPageToken: string | null;
totalSize: number;
}Invitation
interface Invitation {
id: string;
organizationId: string;
email: string;
role: string;
status: "pending" | "accepted" | "expired" | "revoked";
invitedBy: string;
expiresAt: string;
createdAt: string;
acceptedAt: string | null;
}OrganizationList
interface OrganizationList {
organizations: Organization[];
nextPageToken: string | null;
totalSize: number;
}DomainVerification
interface DomainVerification {
domain: string;
status: "pending" | "verified" | "failed";
txtRecord: string;
verifiedAt: string | null;
}See also
- Organizations admin -- Org management methods
- User types -- User types