access

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

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

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте org.update рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте URL мекенжайының өзінде ұйымыңыздың идентификаторын orgId ретінде қабылдайды. Оны жолға қойыңыз — мұны алмастыратын басқа тақырып немесе сұрау параметрі жоқ.

Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`orgId (path)`	`Uuid`	Иә	Organization ID (UUIDv7).

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`require_mfa`	`boolean`	Иә	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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