access

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

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

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie org.update; 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 PUT https://api.zinndigital.com/v1/orgs/{orgId}/auth-policy \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "require_mfa": <boolean> }'

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

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.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`orgId (path)`	`Uuid`	Tak	Organization ID (UUIDv7).

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`require_mfa`	`boolean`	Tak	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`require_mfa`	`boolean`	Tak	When 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 · 422 · 429