access

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

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

Ҳамаи нуқтаҳои ниҳоии access

Санҷиши ҳаққоният

Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати org.update бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.

Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст

Ин нуқтаи ниҳоӣ ID-и ташкилоти шуморо дар худи URL ҳамчун orgId қабул мекунад. Онро ба роҳ ворид кунед — ягон сарлавҳа ё параметри дархосте нест, ки ҷои онро гирад.

Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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

Воarid шудаед? Консоли 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_mfabooleanБалеWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Ҷавоб

НомНамудТалаб карда мешавадИн чӣ аст
require_mfabooleanБалеWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад

401 · 403 · 404 · 422 · 429