Cerbos
Cerbos (latest)
CerbosService
Cerbos Policy Decision Point
postCheck
- postCheck resources
- postCheck resource batch
- postPlan resources
- getGet server information
CerbosAdminService
Cerbos administration service
List audit log entries
- getList audit log entries
- getList policies
- getInspect policies
- getGet policy
- delDisable policy
- postAdd or update policies
- putAdd or update policies
- postDisable policy
- putDisable policy
- postEnable policy
- putEnable policy
- getGet schema
- delDelete schema
- postAdd or update schema
- putAdd or update schema
- getList schemas
- getReload store
Check Resources
Check a principal's permissions to a batch of heterogeneous resources and actions.
Request Body Schema: application/json
| requestId | string Optional application-specific ID useful for correlating logs for analysis. |
| includeMeta | boolean Add request processing metadata to the response. |
| principal required |
object (enginev1Principal) A person or application attempting to perform the actions on the set of resources. |
| resources required |
Array of objects (CheckResourcesRequestResourceEntry) non-empty unique List of resources and actions. |
| auxData | object (cerbosrequestv1AuxData) Structured auxiliary data useful for evaluating the request |
Responses
200 A successful response.
default An unexpected error response.
Request Samples
Payload
Content type
application/json
{"requestId": "c2db17b8-4f9f-4fb1-acfd-9162a02be42b",
"includeMeta": true,
"principal": {"id": "bugs_bunny",
"policyVersion": "default",
"roles": ["user"],
"attr": {"beta_tester": true},
"scope": "acme.corp"},
"resources": [{"actions": ["view","comment"],"resource": {"kind": "album:object","policyVersion": "default","id": "XX125","attr": {"owner": "bugs_bunny","public": false,"flagged": false}}}],
"auxData": {"jwt": {"token": "eyJhbGciOiJFUzM4NCIsImtpZCI6IjE5TGZaYXRFZGc4M1lOYzVyMjNndU1KcXJuND0iLCJ0eXAiOiJKV1QifQ...","keySetId": "my-keyset"}}}
Response Samples
- 200
- default
Get Server Information
Get information about the server e.g. server version
Responses
200 A successful response.
{"version": "string","commit": "string","buildDate": "string"}
List Policies
Authorizations:
BasicAuth
Query Parameters
| includeDisabled | boolean Include disabled policies |
| nameRegexp | string Filter policies by name with regexp |
| scopeRegexp | string Filter policies by scope with regexp |
| versionRegexp | string Filter policies by version with regexp |
| policyId | Array of strings For blob, disk, git stores use file name (.yaml). For mysql, postgres, sqlite3 use id (..) of the policy |
Responses
200 A successful response.
{"policyIds": ["string"]}