Rechercher dans la documentation

Recherchez des pages et des sections dans la documentation.

Aller au contenu

Référence · Référence

Référence API

Trouvez les contrats OpenAPI générés, opérations Better Auth, points de service de confiance et métadonnées de découverte.

Utilisez les contrats générés pour les méthodes, chemins, schémas et réponses exacts. Cette page explique le contrat à ouvrir et sa frontière d'authentification.

Explorateur interactif#

Ouvrez l'explorateur API Scalar. Il contient actuellement :

  • Auth API depuis /api/auth-openapi.json, qui combine les contrats de service et d'administration
  • Better Auth depuis /api/auth/open-api/generate-schema
  • Trusted Backend API depuis /api/backend-openapi.json

Le middleware d'exécution reste l'autorité si la sécurité générée est incomplète.

Frontières d'authentification#

FrontièreIdentifiant
Routes navigateur /api/auth/*Témoin de session et identifiants du flux Better Auth
Routes d'administration par témoinSession d'administrateur de plateforme
Routes utilisateurs, organisations et domaines de confianceClé de service par Authorization: Bearer ou x-api-key
API des applications consommatricesMiddleware de session ou clé et politiques du projet consommateur

La création de domaine de confiance utilise POST /api/domains. Ces points prennent en charge création, recherche par ID ou hôte, enregistrements DNS et suppression. Les mises à jour sont actuellement administratives.

Découverte et disponibilité#

Le service expose des routes well-known racine et les métadonnées Better Auth. Lisez le JSON retourné et configurez le client avec l'issuer, les points et l'URI JWKS exacts. Ne déduisez pas l'émetteur uniquement de l'origine publique, car le chemin de base Better Auth peut en faire partie.

GET /api/auth/ok retourne la disponibilité de l'API. Il ne vérifie pas PostgreSQL ou les dépendances de service.

Sémantique des erreurs#

Utilisez 401 Unauthorized quand l'authentification manque ou est invalide. Utilisez 403 Forbidden lorsqu'un acteur connu n'a pas l'autorisation. Les erreurs de validation décrivent les chemins, requêtes ou charges mal formés. Les services consommateurs devraient conserver ces distinctions et les erreurs Effect typées.

Consultez les exports du SDK, le middleware API et le RBAC.