Configurer le schéma
Configurer le schémaRendre l'API publique ou privée

Rendre l'API publique ou privée

Cette fonctionnalité améliore le contrôle d'accès, pour fournir une visibilité au schéma.

Lorsque l'accès à un champ ou une directive est refusé via le contrôle d'accès, il y a 2 façons pour l'API de se comporter :

Mode public : les champs du schéma sont exposés, et lorsque la permission n'est pas satisfaite, l'utilisateur reçoit un message d'erreur décrivant pourquoi la permission a été refusée. Ce comportement rend les métadonnées du schéma toujours disponibles.

Mode privé : le schéma est personnalisé pour chaque utilisateur, ne contenant que les champs disponibles pour lui ou elle, et ainsi lorsqu'on tente d'accéder à un champ interdit, le message d'erreur indique que le champ n'existe pas. Ce comportement expose les métadonnées du schéma uniquement aux utilisateurs qui peuvent y accéder.

Comment définir la visibilité de l'API

Il existe 3 niveaux auxquels nous pouvons définir la visibilité de l'API, publique ou privée. Par ordre de priorité :

1. Individuellement sur les champs et les directives

Cette option est disponible lorsque l'option "Enable granular control?" dans les réglages est activée (on).

Nous pouvons définir la visibilité pour un ensemble de champs et de directives, lors de la modification de l'entrée depuis la liste de contrôle d'accès :

Mode schéma Public/Privé individuel

2. Sur la configuration du schéma

Nous pouvons définir la visibilité sur la configuration du schéma, pour l'appliquer au custom endpoint ou à la persisted query dans son ensemble :

Mode schéma Public/Privé, défini dans la configuration du schéma
Mode schéma Public/Privé, défini dans la configuration du schéma

3. Mode par défaut, défini dans les Réglages

Si la configuration du schéma a la valeur "Default", le mode défini dans les Réglages sera utilisé :

Mode schéma Public/Privé par défaut
Mode schéma Public/Privé par défaut