Organization Management API

Multi-tenant organization management including CRUD operations, members, settings, BYOO credentials, and end-user management.

Organization Management API

Organizations are the core tenant entities in AuthOS. This section covers all organization management endpoints.

Sections

Section Description
CRUD Operations Create, read, update, and delete organizations
Member Management Manage organization members and roles
Settings SMTP, domain, branding, and risk configuration
OAuth Credentials BYOO (Bring Your Own OAuth) setup
End Users Manage organization end-users

Organization Lifecycle

stateDiagram-v2
    [*] --> Pending: Create Organization
    Pending --> Active: Platform Owner Approves
    Pending --> Rejected: Platform Owner Rejects
    Active --> Suspended: Platform Owner Suspends
    Suspended --> Active: Platform Owner Reactivates
    Active --> [*]: Delete
    Rejected --> [*]: Delete

Role Hierarchy

Role Permissions
Owner Full control, can transfer ownership, delete org
Admin Manage members, services, settings (cannot delete org)
Member View access, use services

Data Model

{
  "id": "uuid",
  "slug": "unique-url-identifier",
  "name": "Organization Display Name",
  "owner_user_id": "uuid",
  "status": "pending | active | suspended | rejected",
  "tier_id": "uuid",
  "max_services": 10,
  "max_users": 100,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Pages