access

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

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung org.update verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt erwartet Ihre Organisations-ID direkt in der URL als orgId. Setzen Sie diese in den Pfad ein – es gibt keinen Header oder Abfrageparameter, der stattdessen verwendet werden kann.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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.

Parameter

Name	Typ	Erforderlich	Was es ist
`orgId (path)`	`Uuid`	Ja	Organization ID (UUIDv7).

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`require_mfa`	`boolean`	Ja	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Antwort

Name	Typ	Erforderlich	Was es ist
`require_mfa`	`boolean`	Ja	When true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429