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

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