Configurar o schema
Configurar o schemaTornando a API pública ou privada

Tornando a API pública ou privada

Esta funcionalidade aprimora o controle de acesso, para fornecer visibilidade ao schema.

Quando o acesso a um campo ou diretiva é negado por meio do controle de acesso, há 2 formas de a API se comportar:

Modo público: os campos do schema são expostos e, quando a permissão não é satisfeita, o usuário recebe uma mensagem de erro descrevendo o motivo pelo qual a permissão foi negada. Esse comportamento torna os metadados do schema sempre disponíveis.

Modo privado: o schema é personalizado para cada usuário, contendo apenas os campos disponíveis para ele ou ela, e assim, ao tentar acessar um campo proibido, a mensagem de erro indica que o campo não existe. Esse comportamento expõe os metadados do schema apenas para os usuários que podem acessá-lo.

Como definir a visibilidade da API

Existem 3 níveis nos quais é possível definir a visibilidade da API, se pública ou privada. Em ordem de prioridade:

1. Individualmente em campos e diretivas

Esta opção está disponível quando a opção "Enable granular control?" nas configurações está on.

É possível definir a visibilidade para um conjunto de campos e diretivas ao editar a entrada na lista de controle de acesso:

Modo de schema Público/Privado individual

2. Na configuração do schema

É possível definir a visibilidade na configuração do schema, para ser aplicada ao custom endpoint ou à persisted query como um todo:

Modo de schema Público/Privado, definido na configuração do schema
Modo de schema Público/Privado, definido na configuração do schema

3. Modo padrão, definido nas Configurações

Se a configuração do schema tiver o valor "Default", o modo definido nas Configurações será utilizado:

Modo de schema Público/Privado padrão
Modo de schema Público/Privado padrão