access

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

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

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա org.update թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այս վերջնակետը որպես orgId ընդունում է ձեր կազմակերպության ID-ն հենց URL-ում: Տեղադրեք այն ուղու մեջ. չկա որևէ վերնագիր կամ հարցման պարամետր, որը կարող է փոխարինել դրան:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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