access

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

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

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền org.update; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.

Nơi điền id tổ chức của bạn

Endpoint này nhận mã tổ chức của bạn trực tiếp trong URL dưới dạng orgId. Hãy thay thế nó vào đường dẫn — không có header hoặc query parameter nào có thể thay thế được.

Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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.

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`orgId (path)`	`Uuid`	Có	Organization ID (UUIDv7).

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`require_mfa`	`boolean`	Có	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`require_mfa`	`boolean`	Có	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 422 · 429