Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cerbos/express-workos-cerbos
https://github.com/cerbos/express-workos-cerbos
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cerbos/express-workos-cerbos
- Owner: cerbos
- Created: 2022-02-01T14:42:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T03:16:30.000Z (4 months ago)
- Last Synced: 2024-09-16T04:41:43.410Z (4 months ago)
- Language: Pug
- Size: 202 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# express-workos-cerbos
An example application of integrating [Cerbos](https://cerbos.dev) with an [Express](https://expressjs.com/) server using [WorkOS](https://workos.com/) for authentication.
## Dependencies
- Node.js
- An WorkOS account
## Getting Started
1. Install node dependencies
```bash
npm install
```
2. Set Config
Create a `.env` file with the following values:
```
PORT=8000
WORKOS_API_KEY=
WORKOS_CLIENT_ID=
WORKOS_CONNECTION_ID=
CERBOS_HOSTNAME=https://demo-pdp.cerbos.cloud
CERBOS_PLAYGROUND=fm7Rj561f9458cJFkUe2FFZCXYrUUVc6
```
You can find the WorkOS values in your dashboard.
> This example is using the hosted Demo PDP of Cerbos and an example Playground instance. If you are running your own Cerbos PDP then update the `CERBOS_HOSTNAME` field to your own instance and remove the `CERBOS_PLAYGROUND` field.
3. Start the express server
```bash
node index.js
```
4. Test the App
Now that everything is wired up you should be able to goto [http://localhost:8000](http://localhost:8000) and press the login link to authenticate with your WorkOS account.
## Policies
This example has a simple CRUD policy in place for a resource kind of `contact` - like a CRM system would have. Should you wish to experiment with this policy, you can try it in the Cerbos Playground.
The policy expects one of two roles to be set on the principal - `admin` and `user`. These roles are authorized as follows:
| Action | User | Admin |
| ------ | -------- | ----- |
| list | Y | Y |
| read | Y | Y |
| create | Y | Y |
| update | If owner | Y |
| delete | If owner | Y |