README.md

@cerbos/grpc

Client library for interacting with the Cerbos policy decision point service over gRPC from server-side Node.js applications.

Prerequisites

• Cerbos 0.16+
• Node.js 18+

Installation

$ npm install @cerbos/grpc

Example usage

import { GRPC } from "@cerbos/grpc";

const cerbos = new GRPC("localhost:3593", { tls: false });

await cerbos.isAllowed({
  principal: {
    id: "user@example.com",
    roles: ["USER"],
    attr: { tier: "PREMIUM" },
  },
  resource: {
    kind: "document",
    id: "1",
    attr: { owner: "user@example.com" },
  },
  action: "view",
}); // => true

For more details, see the GRPC class documentation.

Further reading

• API reference
• Cerbos documentation

Get help

• Join the Cerbos community on Slack
• Email us at help@cerbos.dev