Skip to content
On this page

Privacy Module

Privacy is an extension of the Onboarding Module Hub package (ext-privacy.sql). It ALTERs users with GDPR/CCPA consent flags and privacy_region.

Install with onboarding target: "all" (or the privacy component after core).

Business profile updates are not here. Use Business / PUT /auth/user/me (ext-business).

Friendly rule

  1. Install onboarding + ext-privacy via Module Hub.
  2. First-run wizard may set privacy via POST /auth/user/me/onboarding/complete (Onboarding parent).
  3. After that, use dedicated privacy routes under /auth/user/me/privacy*.
  4. Profile GET (GET /auth/user/me) also returns privacy fields when columns exist.

API

MethodPathNotes
GET/auth/user/me/privacyStatus
POST/auth/user/me/privacy/gdpr-consentConsent + optional privacy_region
DELETE/auth/user/me/privacy/gdpr-consentWithdraw
POST/auth/user/me/privacy/ccpa-opt-outOpt-out

Admin privacy override

Admins can override privacy via PATCH /auth/admin/users/:id/privacy — see Admin API and adminPatchUserPrivacy.

Docs