account

Update Org

Update the caller's organization name.

patch/api/v1/account

Request

  • Base URL: https://app.kaminari.ad
  • URL: https://app.kaminari.ad/api/v1/account
  • Auth: HTTP bearer

Request body

namestring nullable

Response

Successful Response

idstring uuid required
namestring required
owner_idstring uuid nullable required
status'pending_email_verification' | 'pending_admin_approval' | 'active' | 'suspended' | 'rejected' required

Lifecycle state of an :class:Organization.

  • PENDING_EMAIL_VERIFICATION — self-service signup, owner has not clicked the verification link yet.
  • PENDING_ADMIN_APPROVAL — email verified, awaiting admin approval (gated by signup_admin_approval_required flag).
  • ACTIVE — fully usable; users can log in, scans run, billing meters tick.
  • SUSPENDED — admin froze the org (formerly is_active=False).
  • REJECTED — admin denied a self-service signup; soft-delete for audit trail. Recoverable: an admin can approve it in place (REJECTED → ACTIVE via AdminApproveOrganization) or unblock it to free the email for a fresh signup (deletes the owner).
domainstring nullable
created_atstring date-time required
is_activeboolean required

Backward-compat: True iff status == ACTIVE.

Changes

No recorded changes to this operation across all 1 revision of this API.