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