access

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

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

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione org.update; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

L'ID della tua organizzazione va qui

Questo endpoint accetta l'ID della tua organizzazione direttamente nell'URL come orgId. Sostituiscilo nel percorso: non sono presenti intestazioni o parametri di query alternativi.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Nome	Tipo	Obbligatorio	Che cos'è
`orgId (path)`	`Uuid`	Sì	Organization ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`require_mfa`	`boolean`	Sì	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`require_mfa`	`boolean`	Sì	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429