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