Share feedback
Answers are generated based on the documentation.

Schema

PolicySummary

Type: object

Shallow policy representation returned by ListPolicies. Excludes the rule set.
created_at · required

Type: string

All schema constraints and annotations
{
  "examples": [
    "2026-04-22T00:00:00Z"
  ],
  "format": "date-time",
  "type": "string"
}
id · required

Type: string

All schema constraints and annotations
{
  "examples": [
    "pol_06evsmp24r1pg71cm8500546pkbn"
  ],
  "type": "string"
}
name · required

Type: string

Human-readable label, unique within the organization.
All schema constraints and annotations
{
  "description": "Human-readable label, unique within the organization.",
  "examples": [
    "Security Research — hardened"
  ],
  "type": "string"
}
org · required

Type: string

All schema constraints and annotations
{
  "examples": [
    "my-org"
  ],
  "type": "string"
}
scope · required

Schema: Scope

type · required

Type: string

Identifies the policy type. allowlist_v0 for network/filesystem allowlist policies; cedar_v1 for Cedar language policies.
All schema constraints and annotations
{
  "description": "Identifies the policy type. `allowlist_v0` for network/filesystem allowlist policies; `cedar_v1` for Cedar language policies.\n",
  "enum": [
    "allowlist_v0",
    "cedar_v1"
  ],
  "examples": [
    "allowlist_v0"
  ],
  "type": "string"
}
updated_at · required

Type: string

All schema constraints and annotations
{
  "examples": [
    "2026-04-22T00:00:00Z"
  ],
  "format": "date-time",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Shallow policy representation returned by ListPolicies. Excludes the rule set.",
  "properties": {
    "created_at": {
      "examples": [
        "2026-04-22T00:00:00Z"
      ],
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "examples": [
        "pol_06evsmp24r1pg71cm8500546pkbn"
      ],
      "type": "string"
    },
    "name": {
      "description": "Human-readable label, unique within the organization.",
      "examples": [
        "Security Research — hardened"
      ],
      "type": "string"
    },
    "org": {
      "examples": [
        "my-org"
      ],
      "type": "string"
    },
    "scope": {
      "$ref": "#/components/schemas/Scope"
    },
    "type": {
      "description": "Identifies the policy type. `allowlist_v0` for network/filesystem allowlist policies; `cedar_v1` for Cedar language policies.\n",
      "enum": [
        "allowlist_v0",
        "cedar_v1"
      ],
      "examples": [
        "allowlist_v0"
      ],
      "type": "string"
    },
    "updated_at": {
      "examples": [
        "2026-04-22T00:00:00Z"
      ],
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "org",
    "scope",
    "created_at",
    "updated_at",
    "type"
  ],
  "type": "object"
}