Das Schema konfigurieren
Das Schema konfigurierenDie API öffentlich oder privat machen

Die API öffentlich oder privat machen

Diese Funktionalität erweitert die Zugriffskontrolle, um die Sichtbarkeit des Schemas bereitzustellen.

Wenn der Zugriff auf ein Feld oder eine Direktive über die Zugriffskontrolle verweigert wird, gibt es 2 Arten, wie die API reagieren kann:

Öffentlicher Modus: Die Felder im Schema werden angezeigt, und wenn die Berechtigung nicht erfüllt ist, erhält der Benutzer eine Fehlermeldung mit einer Erklärung, warum die Berechtigung verweigert wurde. Dieses Verhalten macht die Metadaten des Schemas immer verfügbar.

Privater Modus: Das Schema wird für jeden Benutzer angepasst und enthält nur die Felder, die ihm oder ihr zur Verfügung stehen. Wenn versucht wird, auf ein gesperrtes Feld zuzugreifen, besagt die Fehlermeldung, dass das Feld nicht existiert. Dieses Verhalten macht die Metadaten des Schemas nur für jene Benutzer sichtbar, die darauf zugreifen können.

Wie die Sichtbarkeit der API definiert wird

Es gibt 3 Ebenen, auf denen die Sichtbarkeit der API – ob öffentlich oder privat – definiert werden kann. In der Reihenfolge der Priorität:

1. Individuell für Felder und Direktiven

Diese Option ist verfügbar, wenn die Option „Enable granular control?" in den Einstellungen on ist.

Die Sichtbarkeit für eine Gruppe von Feldern und Direktiven kann beim Bearbeiten des Eintrags aus der Zugriffskontrollliste definiert werden:

Individueller öffentlicher/privater Schema-Modus

2. In der Schema-Konfiguration

Die Sichtbarkeit kann in der Schema-Konfiguration definiert werden, um sie auf den Custom Endpoint oder die Persisted Query als Ganzes anzuwenden:

Öffentlicher/privater Schema-Modus, in der Schema-Konfiguration festgelegt
Öffentlicher/privater Schema-Modus, in der Schema-Konfiguration festgelegt

3. Standardmodus, in den Einstellungen definiert

Wenn die Schema-Konfiguration den Wert "Default" hat, wird der in den Einstellungen definierte Modus verwendet:

Standard öffentlicher/privater Schema-Modus
Standard öffentlicher/privater Schema-Modus