access

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

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar org.update iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, kuruluş kimliğinizi doğrudan URL içinde orgId olarak alır. Bunu yola ekleyin; bunun yerine geçecek hiçbir başlık veya sorgu parametresi yoktur.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`orgId (path)`	`Uuid`	Evet	Organization ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`require_mfa`	`boolean`	Evet	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`require_mfa`	`boolean`	Evet	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422 · 429