access

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

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

すべての access エンドポイント

認証

ベアラートークンとして API キーを送信します。キーには org.update 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

組織 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