Configurar el esquema
Configurar el esquemaHacer la API pública o privada

Hacer la API pública o privada

Esta funcionalidad mejora el control de acceso, para proporcionar visibilidad al esquema.

Cuando se deniega el acceso a algún campo o directiva mediante control de acceso, hay 2 formas en que la API puede comportarse:

Modo público: los campos del esquema están expuestos, y cuando no se cumple el permiso, el usuario obtiene un mensaje de error con una descripción del motivo por el que el permiso fue rechazado. Este comportamiento hace que los metadatos del esquema estén siempre disponibles.

Modo privado: el esquema se personaliza para cada usuario, conteniendo únicamente los campos disponibles para él o ella, y por tanto al intentar acceder a un campo prohibido, el mensaje de error indica que el campo no existe. Este comportamiento expone los metadatos del esquema solo a aquellos usuarios que pueden acceder a él.

Cómo definir la visibilidad de la API

Hay 3 niveles en los que podemos definir la visibilidad de la API, pública o privada. Por orden de prioridad:

1. Individualmente en campos y directivas

Esta opción está disponible cuando la opción "Enable granular control?" en los ajustes está activada (on).

Podemos definir la visibilidad para un conjunto de campos y directivas, al editar la entrada desde la access control list:

Modo Público/Privado individual del esquema

2. En la configuración del esquema

Podemos definir la visibilidad en la configuración del esquema, para que se aplique al endpoint personalizado o consulta persistida en su conjunto:

Modo Público/Privado del esquema, configurado en la Schema configuration
Modo Público/Privado del esquema, configurado en la Schema configuration

3. Modo por defecto, definido en los Ajustes

Si la configuración del esquema tiene el valor "Default", utilizará el modo definido en los Ajustes:

Modo Público/Privado del esquema por defecto
Modo Público/Privado del esquema por defecto