access

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

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

Authentication

Send an API key as a bearer token. The key must carry the org.update permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes your organisation id in the URL itself, as orgId. Substitute it into the path — there is no header or query parameter that will do instead.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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.

Parameters

Name	Type	Required	What it is
`orgId (path)`	`Uuid`	Yes	Organization ID (UUIDv7).

Request body

Name	Type	Required	What it is
`require_mfa`	`boolean`	Yes	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Response

Name	Type	Required	What it is
`require_mfa`	`boolean`	Yes	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429