access

GET /v1/orgs/{orgId}/auth-policy

Read an org's authentication policy.

Tous les points de terminaison access

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation org.read ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison intègre l'identifiant de votre organisation directement dans l'URL, sous la forme orgId. Insérez-le dans le chemin d'accès, car aucun en-tête ni paramètre de requête ne peut s'y substituer.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/auth-policy \
  -H "Authorization: Bearer zdk_live_…"

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

The org's per-org authentication policy (docs/35 #4). Requires `org.read`.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
orgId (path)UuidOuiOrganization ID (UUIDv7).

Réponse

NomTypeObligatoireQu'est-ce que c'est
require_mfabooleanOuiWhen true, members must authenticate with a second factor (TOTP or a passkey) to exercise this org's access.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 429