access

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

Read an org's authentication policy.

Усі кінцеві точки access

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл org.read; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Ця кінцева точка приймає ідентифікатор вашої організації безпосередньо в URL як orgId. Підставте його в шлях — немає заголовка чи параметра запиту, які б замінили це.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/auth-policy \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

The org's per-org authentication policy (docs/35 #4). Requires `org.read`.

Параметри

НазваТипОбов'язковеЩо це таке
orgId (path)UuidТакOrganization ID (UUIDv7).

Відповідь

НазваТипОбов'язковеЩо це таке
require_mfabooleanТакWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429