Het schema configureren
Het schema configurerenDe API publiek of privé maken

De API publiek of privé maken

Deze functionaliteit breidt toegangsbeheer uit om zichtbaarheid van het schema te bieden.

Wanneer toegang tot een veld of directive wordt geweigerd via toegangsbeheer, zijn er 2 manieren waarop de API zich kan gedragen:

Publieke modus: de velden in het schema zijn zichtbaar, en wanneer de toestemming niet is voldaan, krijgt de gebruiker een foutmelding met een beschrijving van waarom de toestemming is geweigerd. Dit gedrag maakt de metadata van het schema altijd beschikbaar.

Privémodus: het schema wordt aangepast aan elke gebruiker en bevat alleen de velden die beschikbaar zijn voor die persoon. Wanneer iemand probeert toegang te krijgen tot een verboden veld, meldt de foutmelding dat het veld niet bestaat. Dit gedrag stelt de metadata van het schema alleen beschikbaar aan gebruikers die er toegang toe hebben.

Hoe je de zichtbaarheid van de API definieert

Er zijn 3 niveaus waarop je de zichtbaarheid van de API kunt definiëren, of die nu publiek of privé is. In volgorde van prioriteit:

1. Individueel voor velden en directives

Deze optie is beschikbaar wanneer optie "Enable granular control?" in de instellingen is ingesteld op on.

Je kunt de zichtbaarheid voor een set velden en directives definiëren bij het bewerken van het item uit de toegangsbeheerslijst:

Individuele publieke/privé-schemamodus

2. In de schemaconfiguratie

Je kunt de zichtbaarheid definiëren in de schemaconfiguratie, zodat deze wordt toegepast op het custom endpoint of de persisted query als geheel:

Publieke/privé-schemamodus ingesteld in de schemaconfiguratie
Publieke/privé-schemamodus ingesteld in de schemaconfiguratie

3. Standaardmodus, gedefinieerd in de Instellingen

Als de schemaconfiguratie de waarde "Default" heeft, wordt de modus gebruikt die in de Instellingen is gedefinieerd:

Standaard publieke/privé-schemamodus
Standaard publieke/privé-schemamodus