access

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

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

Doğrulama

API açarını bearer token kimi göndərin. Açar org.update icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə təşkilatınızın identifikatorunu birbaşa URL-də orgId kimi qəbul edir. Onu yola daxil edin — bunun əvəzinə işləyəcək heç bir başlıq və ya sorğu parametri yoxdur.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`orgId (path)`	`Uuid`	Bəli	Organization ID (UUIDv7).

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`require_mfa`	`boolean`	Bəli	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Cavab

Ad	Tip	Tələb olunur	Nədir
`require_mfa`	`boolean`	Bəli	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422 · 429