Mesh
On this page

Operation Field Permissions

GraphQL Mesh v0 documentation (superseded by v1): Restrict API access to certain public fields with `@graphql-mesh/plugin-operation-field-permissions`. Use this plugin to manage field-level permissions in your GraphQL schema.

You can use @graphql-mesh/plugin-operation-field-permissions plugin to restrict the scope of certain public API users to a subset of the public GraphQL schema.

Based on Envelop’s useOperationFieldPermissions

This plugin and authentication on a plugin or source level are complementary. See authentication guide for more details.

Getting Started

npm i @graphql-mesh/plugin-operation-field-permissions

Example Configuration

.meshrc.yaml
# ...
plugins:
  - operationFieldPermissions:
      permissions:
        - if: 'context._auth0?.sub != null'
          allow:
            - '*'

Config API Reference

  • permissions (type: Array of Object):
    • if (type: String)
    • allow (type: Array of String)