access

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

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

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie org.update beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt gebruikt je organisatie-id rechtstreeks in de URL als orgId. Vervang dit in het pad; er is geen header of queryparameter die dit kan overnemen.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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

Naam	Type	Verplicht	Wat dit is
`orgId (path)`	`Uuid`	Ja	Organization ID (UUIDv7).

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`require_mfa`	`boolean`	Ja	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Reactie

Naam	Type	Verplicht	Wat dit is
`require_mfa`	`boolean`	Ja	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429