# Cerbos (latest)

## CerbosService

Cerbos Policy Decision Point

### Check Resource Set (Deprecated)  
Check whether a principal has permissions to perform the given actions on a set of resource instances.

#### Request Body
|     |     |
| --- | --- |
| requestId | string - Optional application-specific ID useful for correlating logs for analysis. |
| actions | Array of strings - List of actions being performed on the set of resources. |
| principal | object - A person or application attempting to perform the actions on the set of resources. |
| resource | object - Set of resources to check |
| includeMeta | boolean - Opt to receive request processing metadata in the response. |
| auxData | object - Structured auxiliary data useful for evaluating the request |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

## Check Resources
Check a principal's permissions to a batch of heterogeneous resources and actions.

#### Request Body
|     |     |
| --- | --- |
| requestId | string - Optional application-specific ID useful for correlating logs for analysis. |
| includeMeta | boolean - Add request processing metadata to the response. |
| principal | object - A person or application attempting to perform the actions on the set of resources. |
| resources | Array of objects - List of resources and actions. |
| auxData | object - Structured auxiliary data useful for evaluating the request |
| requestContext | object - Optional metadata to attach to the request. |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Check Resource Batch (Deprecated)
Check a principal's permissions to a batch of heterogeneous resources and actions.

#### Request Body
|     |     |
| --- | --- |
| requestId | string - Optional application-specific ID useful for correlating logs for analysis. |
| principal | object - A person or application attempting to perform the actions on the set of resources. |
| resources | Array of objects - List of resources and actions. |
| auxData | object - Structured auxiliary data useful for evaluating the request |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Plan Resources
Produce a query plan with conditions that must be satisfied for accessing a set of instances of a resource

#### Request Body
|     |     |
| --- | --- |
| requestId | string - Optional application-specific ID useful for correlating logs for analysis. |
| action | string - Action to be applied to each resource in the list. |
| actions | Array of strings - List of actions to generate the query plan for. |
| principal | object - A person or application attempting to perform the actions on the set of resources. |
| resource | object - Resource details |
| auxData | object - Structured auxiliary data useful for evaluating the request |
| includeMeta | boolean - Opt to receive request processing metadata in the response. |
| requestContext | object - Optional metadata to attach to the request. |

#### Responses
**200**
A successful response.

## Get Server Information
Get information about the server e.g. server version

#### Responses
**200**
A successful response.

## CerbosAdminService
Cerbos administration service

### List Audit Log Entries  
##### Authorizations:
_BasicAuth_

##### path Parameters
|     |     |
| --- | --- |
| kind | string - Kind of log entry |

##### query Parameters
|     |     |
| --- | --- |
| tail | integer - Last N entries. |
| between.start | string - Start date in ISO 8601 format. |
| between.end | string - End date in ISO 8601 format. |
| since | string - Entries since N hours/minutes ago |
| lookup | string - By Call ID |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### 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). |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Inspect Policies
##### Authorizations:
_BasicAuth_

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Get Policy
##### Authorizations:
_BasicAuth_

##### query Parameters
|     |     |
| --- | --- |
| id | Array of strings - For blob, disk, git stores use file name (.yaml). |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Disable Policy
##### Authorizations:
_BasicAuth_

##### query Parameters
|     |     |
| --- | --- |
| id | Array of strings - Unique identifier for the policy |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Add or Update Policies
##### Authorizations:
_BasicAuth_

##### Request Body
|     |     |
| --- | --- |
| policies | Array of objects - List of policies. |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Get Schema
##### Authorizations:
_BasicAuth_

##### query Parameters
|     |     |
| --- | --- |
| id | Array of strings - Unique identifier for the schema |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.

### Add or Update Schema
##### Authorizations:
_BasicAuth_

##### Request Body
|     |     |
| --- | --- |
| schemas | Array of objects - List of schemas. |

#### Responses
**200**
A successful response.

**default**
An unexpected error response.