access

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

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

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya org.update; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Kituo hiki cha mwisho kinachukua kitambulisho cha shirika lako katika URL yenyewe, kama orgId. Kiweke kwenye njia — hakuna kichwa au kigezo cha hoja ambacho kitafanya kazi badala yake.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`orgId (path)`	`Uuid`	Ndiyo	Organization ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`require_mfa`	`boolean`	Ndiyo	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`require_mfa`	`boolean`	Ndiyo	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422 · 429