useOrganizationList

Manage organizations, members, invitations, domains, and enterprise connections.

useOrganizationList

The useOrganizationList hook provides methods for managing organizations the user is a member of, including creating, updating, deleting organizations, and managing members, roles, invitations, and domains.

Return Value

organizations · Organization[]

List of organizations the user is a member of

loading · boolean

Whether data is loading

error · Error | null

Any error that occurred

refetch

Show Refetch the organizations list

returns · Promise<void>

Resolves when the organizations list is refetched

leaveOrganization

Show Leave an organization

organization · Organization

The organization to leave

returns · Promise<void>

Resolves when the organization is left

createOrganization

Show Create a new organization

params · { name: string; description?: string; image?: File }

Organization creation parameters

returns · Promise<Organization>

The created organization

updateOrganization

Show Update an existing organization

organization · Organization

The organization to update

params · Partial<{ name: string; description?: string; image?: File }>

Organization fields to update

returns · Promise<Organization>

The updated organization

deleteOrganization

Show Delete an organization

organization · Organization

The organization to delete

returns · Promise<void>

Resolves when the organization is deleted

getOrganizationMembers

Show Get organization members

organization · Organization

The organization

returns · Promise<OrganizationMember[]>

List of organization members

removeOrganizationMember

Show Remove an organization member

organization · Organization

The organization

member · OrganizationMembership

The member to remove

returns · Promise<void>

Resolves when the member is removed

getOrganizationRoles

Show Get organization roles

organization · Organization

The organization

returns · Promise<OrganizationRole[]>

List of organization roles

addRoleToOrganizationMember

Show Add a role to an organization member

organization · Organization

The organization

member · OrganizationMembership

The member

role · OrganizationRole

The role to add

returns · Promise<void>

Resolves when the role is added

removeRoleFromOrganizationMember

Show Remove a role from an organization member

organization · Organization

The organization

member · OrganizationMembership

The member

role · OrganizationRole

The role to remove

returns · Promise<void>

Resolves when the role is removed

getOrganizationInvitations

Show Get organization invitations

organization · Organization

The organization

returns · Promise<OrganizationInvitation[]>

List of organization invitations

inviteOrganizationMember

Show Invite a user to an organization

organization · Organization

The organization

invitation · OrganizationInvitationPayload

The invitation details

returns · Promise<OrganizationInvitation>

The created invitation

discardOrganizationInvitation

Show Discard an organization invitation

organization · Organization

The organization

invitation · OrganizationInvitation

The invitation to discard

returns · Promise<void>

Resolves when the invitation is discarded

resendOrganizationInvitation

Show Resend an organization invitation

organization · Organization

The organization

invitation · OrganizationInvitation

The invitation to resend

returns · Promise<OrganizationInvitation>

The resent invitation

getOrganizationDomains

Show Get organization domains

organization · Organization

The organization

returns · Promise<OrganizationDomain[]>

List of organization domains

addOrganizationDomain

Show Add a domain to an organization

organization · Organization

The organization

domain · string

The domain to add

returns · Promise<OrganizationDomain>

The added domain

verifyOrganizationDomain

Show Verify an organization domain

organization · Organization

The organization

domain · OrganizationDomain

The domain to verify

returns · Promise<OrganizationDomain>

The verified domain

removeOrganizationDomain

Show Remove a domain from an organization

organization · Organization

The organization

domain · OrganizationDomain

The domain to remove

returns · Promise<void>

Resolves when the domain is removed

getEnterpriseConnections

Show Get enterprise SSO connections

organization · Organization

The organization

returns · Promise<EnterpriseConnection[]>

List of enterprise SSO connections

createEnterpriseConnection

Show Create an enterprise SSO connection

organization · Organization

The organization

config · EnterpriseConnectionConfig

The SSO connection configuration

returns · Promise<EnterpriseConnection>

The created connection

updateEnterpriseConnection

Show Update an enterprise SSO connection

organization · Organization

The organization

connection · EnterpriseConnection

The connection to update

config · Partial<EnterpriseConnectionConfig>

The configuration updates

returns · Promise<EnterpriseConnection>

The updated connection

deleteEnterpriseConnection

Show Delete an enterprise SSO connection

organization · Organization

The organization

connection · EnterpriseConnection

The connection to delete

returns · Promise<void>

Resolves when the connection is deleted

testEnterpriseConnection

Show Test an enterprise SSO connection

organization · Organization

The organization

connection · EnterpriseConnection

The connection to test

returns · Promise<TestResult>

Test result with success status and checks

Data Structures

Show Organization

interface Organization {
  id: string;
  name: string;
  image_url: string;
  description: string;
  member_count: number;
  public_metadata: Record<string, unknown>;
  private_metadata: Record<string, unknown>;
  enforce_mfa: boolean;
  enable_ip_restriction: boolean;
  whitelisted_ips: string[];
  auto_assigned_workspace_id: string;
  created_at: string;
  updated_at: string;
  segments: Segment[];
}

Examples

Basic Organization List

import { useOrganizationList } from "@wacht/nextjs";

function OrganizationsPage() {
  const { organizations, loading, createOrganization } = useOrganizationList();

  const handleCreate = async () => {
    await createOrganization({
      name: "Acme Inc",
      description: "My company",
    });
  };

  return (
    <div>
      {organizations.map((org) => (
        <div key={org.id}>{org.name}</div>
      ))}
      <button onClick={handleCreate}>Create Organization</button>
    </div>
  );
}

CRUD Operations

Create Organization

await createOrganization({
  name: "Acme Inc",
  description: "My company description",
  image: file, // Optional File object
});

Update Organization

await updateOrganization(organization, {
  name: "New Name",
  description: "New description",
  image: file,
});

Delete Organization

await deleteOrganization(organization);

Leave Organization

await leaveOrganization(organization);

Invite Member

await inviteOrganizationMember(organization, {
  email: "[e-mail]",
  organizationRole: { id: "role_id" },
  workspace: { id: "workspace_id" },
  workspaceRole: { id: "workspace_role_id" },
});

Enterprise SSO

Create SSO Connection

await createEnterpriseConnection(organization, {
  protocol: "saml",
  idp_entity_id: "https://idp.example.com/entity_id",
  idp_sso_url: "https://idp.example.com/sso",
  idp_certificate: "-----BEGIN CERTIFICATE-----\n...",
  jit_enabled: true,
});

Test SSO Connection

const result = await testEnterpriseConnectionConfig(organization, {
  protocol: "saml",
  idp_entity_id: "https://idp.example.com/entity_id",
  idp_sso_url: "https://idp.example.com/sso",
  idp_certificate: "-----BEGIN CERTIFICATE-----\n...",
});

// result.success: boolean
// result.checks: { [key: string]: boolean }
// result.errors?: { [key: string]: string }

SCIM Token Management

// Generate SCIM token
const tokenInfo = await generateSCIMToken(organization, connectionId);

// Get SCIM token
const tokenInfo = await getSCIMToken(organization, connectionId);

// Revoke SCIM token
await revokeSCIMToken(organization, connectionId);

Related

• useActiveOrganization - Active organization
• useOrganizationMemberships - Memberships list
• CreateOrganizationForm - Create org form