@cerbos/http/README.md

Client library for interacting with the Cerbos policy decision point service over HTTP from browser-based applications

# @cerbos/http

[![npm](https://img.shields.io/npm/v/@cerbos/http?style=flat-square)](https://www.npmjs.com/package/@cerbos/http)

Client library for interacting with the Cerbos policy decision point service over HTTP.

This is primarily intended for use in browsers, and requires `fetch` to be available globally.
If you're targeting [old browsers](https://caniuse.com/fetch), you'll need to apply [a polyfill](https://www.npmjs.com/package/whatwg-fetch).

You can use it in server-side Node.js applications, but the [gRPC client](../grpc/README.md) might be more appropriate.

## Prerequisites

- Cerbos 0.16+
- Node.js 20+
- `fetch`

## Installation

```console
$ npm install @cerbos/http
```

## Example usage

```typescript
import { HTTP } from "@cerbos/http";

const cerbos = new HTTP("http://localhost:3592");

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 `HTTP` class documentation](../../docs/http.http.md).

## Further reading

- [API reference](../../docs/http.md)
- [Cerbos documentation](https://docs.cerbos.dev)

## Get help

- [Join the Cerbos community on Slack](http://go.cerbos.io/slack)
- [Email us at help@cerbos.dev](mailto:help@cerbos.dev)