Konfigurowanie schematu
Konfigurowanie schematuUczynienie API publicznym lub prywatnym

Uczynienie API publicznym lub prywatnym

Ta funkcjonalność rozszerza kontrolę dostępu, zapewniając widoczność schematu.

Gdy dostęp do pola lub dyrektywy jest odmówiony przez kontrolę dostępu, API może zachowywać się na 2 sposoby:

Tryb publiczny: pola schematu są ujawnione, a gdy uprawnienie nie jest spełnione, użytkownik otrzymuje komunikat o błędzie z opisem, dlaczego uprawnienie zostało odrzucone. To zachowanie sprawia, że metadane schematu są zawsze dostępne.

Tryb prywatny: schemat jest dostosowywany do każdego użytkownika, zawierając tylko pola dostępne dla danej osoby, a gdy próbuje uzyskać dostęp do zakazanego pola, komunikat o błędzie informuje, że pole nie istnieje. To zachowanie udostępnia metadane schematu tylko tym użytkownikom, którzy mają do nich dostęp.

Jak zdefiniować widoczność API

Istnieją 3 poziomy, na których można zdefiniować widoczność API — publiczną lub prywatną. W kolejności priorytetu:

1. Indywidualnie dla pól i dyrektyw

Ta opcja jest dostępna, gdy opcja "Enable granular control?" w ustawieniach jest ustawiona na on.

Można zdefiniować widoczność dla zestawu pól i dyrektyw podczas edytowania wpisu z listy kontroli dostępu:

Indywidualny tryb schematu Publiczny/Prywatny

2. W konfiguracji schematu

Można zdefiniować widoczność w konfiguracji schematu, aby była stosowana do custom endpoint lub persisted query jako całości:

Tryb schematu Publiczny/Prywatny ustawiony w konfiguracji schematu
Tryb schematu Publiczny/Prywatny ustawiony w konfiguracji schematu

3. Tryb domyślny zdefiniowany w Ustawieniach

Jeśli konfiguracja schematu ma wartość "Default", zostanie użyty tryb zdefiniowany w Ustawieniach:

Domyślny tryb schematu Publiczny/Prywatny
Domyślny tryb schematu Publiczny/Prywatny