access

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

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

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास org.update अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट URL में ही आपके संगठन की आईडी को orgId के रूप में लेता है। इसे पाथ में बदलें — इसके विकल्प के रूप में काम करने वाला कोई हेडर या क्वेरी पैरामीटर नहीं है।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

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.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`orgId (path)`	`Uuid`	हाँ	Organization ID (UUIDv7).

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`require_mfa`	`boolean`	हाँ	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`require_mfa`	`boolean`	हाँ	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 422 · 429

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