access

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

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

Svi access krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu org.update; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća ID vaše organizacije u samom URL-u, kao orgId. Zamijenite ga u stazi — ne postoji zaglavlje ili parametar upita koji će umjesto toga poslužiti.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

NazivVrstaObaveznoŠto je to
orgId (path)UuidDaOrganization ID (UUIDv7).

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
require_mfabooleanDaWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Odgovor

NazivVrstaObaveznoŠto je to
require_mfabooleanDaWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422 · 429