Documentation Index
Fetch the complete documentation index at: https://docs.kavachos.com/llms.txt
Use this file to discover all available pages before exploring further.
Setup
Add theorganization plugin to your KavachOS instance:
Creating organizations
owner role.
Inviting members
Managing members
Roles and permissions
Four built-in roles ship by default:| Role | Permissions |
|---|---|
owner | All permissions including org:manage, org:delete, roles:manage |
admin | members:invite, members:remove, agents:create, agents:revoke, agents:manage |
member | agents:create, agents:manage |
viewer | None |
Custom roles
Set
allowCustomRoles: false in the plugin config to restrict orgs to the built-in roles only.Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /auth/org | Create organization |
| GET | /auth/org/user/:userId | List orgs for user |
| GET | /auth/org/:orgId | Get organization |
| PATCH | /auth/org/:orgId | Update organization |
| DELETE | /auth/org/:orgId | Delete organization |
| GET | /auth/org/:orgId/members | List members |
| POST | /auth/org/:orgId/members | Add member |
| PATCH | /auth/org/:orgId/members/:userId | Update member role |
| DELETE | /auth/org/:orgId/members/:userId | Remove member |
| POST | /auth/org/:orgId/invite | Send invitation |
| GET | /auth/org/:orgId/invitations | List invitations |
| POST | /auth/org/invite/:invitationId/accept | Accept invitation |
| DELETE | /auth/org/invite/:invitationId | Revoke invitation |
| GET | /auth/org/:orgId/roles | List roles |
| POST | /auth/org/:orgId/roles | Create role |
| GET | /auth/org/:orgId/permissions/:userId/:permission | Check permission |