access

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

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění org.update; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přebírá ID vaší organizace přímo v URL jako orgId. Dosaďte jej do cesty – neexistuje žádná hlavička ani parametr dotazu, které by to udělaly místo toho.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Název	Typ	Požadováno	Co to je
`orgId (path)`	`Uuid`	Ano	Organization ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`require_mfa`	`boolean`	Ano	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Odpověď

Název	Typ	Požadováno	Co to je
`require_mfa`	`boolean`	Ano	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429