access

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

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

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso org.update; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint toma el id de tu organización directamente en la URL, como orgId. Sustitúyelo en la ruta; no hay ninguna cabecera ni parámetro de consulta que sirva para ello.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`orgId (path)`	`Uuid`	Sí	Organization ID (UUIDv7).

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`require_mfa`	`boolean`	Sí	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`require_mfa`	`boolean`	Sí	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429