access

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

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

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429

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