access

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

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

Të gjitha pikat e skajshme access

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen org.update; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint merr ID-në e organizatës suaj direkt në URL, si orgId. Zëvendësoni atë në shteg — nuk ka asnjë kokë (header) apo parametër query që bën punë në vend të kësaj.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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.

Parametrat

EmriLlojiKërkohetÇfarë është kjo
orgId (path)UuidPoOrganization ID (UUIDv7).

Trupi i kërkesës

EmriLlojiKërkohetÇfarë është kjo
require_mfabooleanPoWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
require_mfabooleanPoWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 422 · 429