access
PUT /v1/orgs/{orgId}/auth-policy
Set an org's authentication policy (require MFA).
Xaqiijinta aqoonsiga
U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda org.update; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.
Meesha aqoonsiga ururkaagu galayo
Bankani wuxuu qaataa aqoonsiga ururkaaga URL-ka dhexdiisa, sida orgId. Ku beddel wadada dhexdeeda — ma jiro madax (header) ama cabbir weydiin (query parameter) beddeli kara.
Aqoonsiga ururkaagu wuxuu ku yaallaa shaashada furayaasha API ee dashboard-kaaga, oo ku xiga furaha laftiisa. Waa isku aqoonsi wicitaan kasta oo aad sameyso.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
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> }'Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Faahfaahin
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.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
orgId (path) | Uuid | Haa | Organization ID (UUIDv7). |
Codsiga jidhkiisa
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
require_mfa | boolean | Haa | When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access. |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
require_mfa | boolean | Haa | When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access. |
Cilladaha ay bartaani soo celin karto
401 · 403 · 404 · 422 · 429