access

PUT `/v1/orgs/{orgId}/auth-policy`

Set an org's authentication policy (require MFA).

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה org.update; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את מזהה הארגון שלך בכתובת ה-URL עצמה, בתור orgId. השתמש בו בנתיב — אין כותרת או פרמטר שאילתת חיפוש שיעשו זאת במקומו.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X PUT https://api.zinndigital.com/v1/orgs/{orgId}/auth-policy \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "require_mfa": <boolean> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Require (or stop requiring) a second factor for this org's members (docs/35 #4). When required, a member on a password-only session gets none of the org's permissions until they re-authenticate with MFA. Requires `org.update`; **enabling** additionally requires the caller's own session to be MFA (403 otherwise) so an admin cannot lock themselves out.

פרמטרים

שם	סוג	נדרש	מה זה
`orgId (path)`	`Uuid`	כן	Organization ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`require_mfa`	`boolean`	כן	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

תשובה

שם	סוג	נדרש	מה זה
`require_mfa`	`boolean`	כן	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429