access
PUT /v1/orgs/{orgId}/auth-policy
Set an org's authentication policy (require MFA).
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea org.update; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final preia ID-ul organizației tale direct în URL, sub forma orgId. Înlocuiește-l în cale — nu există niciun antet sau parametru de interogare care să țină locul acestuia.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
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> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
orgId (path) | Uuid | Da | Organization ID (UUIDv7). |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
require_mfa | boolean | Da | When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
require_mfa | boolean | Da | When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access. |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422 · 429