access

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

Read an org's authentication policy.

Wszystkie punkty końcowe access

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie org.read; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy pobiera identyfikator Twojej organizacji bezpośrednio z adresu URL jako orgId. Podstaw go w ścieżce — nie ma nagłówka ani parametru zapytania, które mogłyby go zastąpić.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

NazwaTypWymaganeCo to jest
orgId (path)UuidTakOrganization ID (UUIDv7).

Odpowiedź

NazwaTypWymaganeCo to jest
require_mfabooleanTakWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429