access

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

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

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão org.update; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita o ID da sua organização diretamente na URL, como orgId. Substitua-o no caminho — não há cabeçalho ou parâmetro de consulta que sirva como alternativa.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Nome	Tipo	Obrigatório	O que é
`orgId (path)`	`Uuid`	Sim	Organization ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`require_mfa`	`boolean`	Sim	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Resposta

Nome	Tipo	Obrigatório	O que é
`require_mfa`	`boolean`	Sim	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429