Policy.schema.json

Policy Overview

This document outlines the structure and rules of the Cerbos policy.

API Version

• apiVersion: api.cerbos.dev/v1

Derived Roles

• derivedRoles: Defines roles that are composed of other roles.

Descriptions

• description: Provide a brief description of the policy.

Metadata

• metadata: Contains additional information about the policy, such as annotations and source file.

Principal Policy

• principalPolicy: A set of rules for defining user permissions and restrictions.
  • principal: Specifies the identity of the principal.
  • rules: A collection of rules that define what actions are allowed or denied.

Resource Policy

• resourcePolicy: Outlines permissions related to specific resources.
  • resource: Specifies the resource subject to the policy.
  • rules: A collection of rules governing access to the resource.

Role Policy

• rolePolicy: Defines roles and associated rules.
  • role: Specifies the name of the role.
  • rules: A set of rules that apply to the role.

Export Constants and Variables

• exportConstants: Constants that can be used in other policies.
• exportVariables: Variables that can be referenced across the policy framework.