Codes d'erreur d'authentification
Chaque erreur que renvoie le serveur d'authentification Scrydon porte un code stable. Décidez d'après le code, jamais d'après le message, et traduisez par le code.
Quand le serveur d'authentification Scrydon refuse un appel, la réponse porte
un statut HTTP et un corps JSON avec un code et un message :
{
"code": "ORGANIZATION_ADMIN_REQUIRED",
"message": "Only organization owners and admins can do this"
}| Champ | Ce que c'est |
|---|---|
code | Un identifiant stable en UPPER_SNAKE_CASE. Il ne change pas d'une version à l'autre, sauf si les notes de version le disent. |
message | Une phrase en anglais, destinée à être lue par une personne. Sa formulation peut changer à chaque version. |
Certains codes envoient aussi des champs supplémentaires qui nomment ce qui n'allait pas, par exemple le champ dont la validation a échoué.
Décidez d'après code, jamais d'après message
Votre client doit décider quoi faire à partir du code (et du statut HTTP),
jamais à partir du message. Un message peut être reformulé, corrigé ou
raccourci à chaque version : un test comme message.includes("admin") cessera
de fonctionner sans prévenir.
const { error } = await authClient.organization.setActive({ organizationId });
if (error?.code === "IDENTITY_NETWORK_NOT_ALLOWED") {
showNetworkHelp();
} else if (error) {
showError(error.message);
}Afficher l'erreur à une personne
Pour afficher une erreur dans la langue de la personne, cherchez le code
dans vos propres traductions. Si vous n'avez pas de traduction pour ce code,
affichez le message. S'il n'y a ni l'un ni l'autre, affichez une phrase
générique de votre choix.
Les applications web Scrydon suivent cet ordre, et elles ont une traduction de chaque code en anglais, espagnol, français, allemand et néerlandais.
Points de terminaison de protocole
Deux types de points de terminaison utilisent plutôt le format d'erreur que leur norme définit :
| Points de terminaison | Format |
|---|---|
| Points de terminaison de jeton et d'autorisation OAuth 2.0 et OpenID Connect | { "error": "invalid_grant", "error_description": "…" } (RFC 6749 §5.2). Décidez d'après error. |
Provisionnement SCIM (/scim/v2/…) | { "schemas": [...], "status": "…", "detail": "…" } (RFC 7644 §3.12). Décidez d'après status, et d'après scimType quand il est présent. |
Une application qui envoie une personne se connecter reçoit l'error OAuth
sur son URI de redirection, par exemple error=access_denied.