access

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

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

所有 access 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 org.update 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

您的组织 ID 应填在此处

此端点直接在 URL 中接受您的组织 ID，即 orgId。请将其替换到路径中——没有其他标头或查询参数可以替代此操作。

您的组织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