# AiGovernanceList

An allow or deny list of AI tools, MCP servers, skills or clients, stored as AI Firewall guardrails.

An allow or deny list of AI tools, MCP servers, skills or clients, stored as AI Firewall guardrails: one guardrail row per pattern, of rule type <family>_<list>. The list owns its rows, so removing a pattern removes its row. The same list can be written inline as AiFirewallPolicy spec.capabilities.

| | |
|---|---|
| `apiVersion` | `vulnetix.com/v1` |
| `kind` | `AiGovernanceList` |
| Group | [AI firewall](/platform-iac/kinds/catalogue.md#ai-firewall) |
| Status | **Served.** The [config engine](/platform-iac/reference/engine.md) plans and applies it. |
| Objects per tenant | many, keyed by `metadata.name` |
| Token and role | An owner, or a service account with the developer role (its ApiKey), or an Authentik access token for either. A member is refused with HTTP 403. See [Credentials for automation](/platform-iac/reference/config-api.md#credentials-for-automation). |
| Terraform resource | [`vulnetix_ai_governance_list`](/platform-iac/terraform/resources.md#vulnetix_ai_governance_list), imported by name (see [Terraform and OpenTofu](#terraform-and-opentofu)) |
| CLI | [`vulnetix config apply`](/platform-iac/cli/apply.md), CLI v3.157.0 and later. |
| Pinned schema | [`v1.19.1/AiGovernanceList.schema.json`](https://github.com/Vulnesis/config-schemas/releases/download/v1.19.1/AiGovernanceList.schema.json) |
| Newest schema | [`latest/AiGovernanceList.schema.json`](https://github.com/Vulnesis/config-schemas/releases/latest/download/AiGovernanceList.schema.json) |
| First released in | [`v1.1.0`](https://github.com/Vulnesis/config-schemas/releases/tag/v1.1.0) |
| Print the built-in copy | `vulnetix config schema AiGovernanceList` |

## Minimal

Only the fields the kind requires. From `examples/AiGovernanceList/minimal.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AiGovernanceList.schema.json
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: deny-shell-tools
spec:
  family: tool
  list: deny
  action: block
  patterns:
    - Bash
```

**HCL** (resource `vulnetix_ai_governance_list`)

```hcl
# Only the arguments the kind requires. From config-schemas examples/AiGovernanceList/minimal.yaml.

resource "vulnetix_ai_governance_list" "deny_shell_tools" {
  name     = "deny-shell-tools"
  action   = "block"
  family   = "tool"
  list     = "deny"
  patterns = ["Bash"]
}
```

Every field that has a schema default, set to that default: [`terraform/ai_governance_list.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/ai_governance_list.tf) and [`yaml/AiGovernanceList.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/AiGovernanceList.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AiGovernanceList.schema.json
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: deny-shell-tools
spec:
  family: tool
  list: deny
  action: block
  patterns:
    - Bash
EOF
```

## Advanced

Every field the kind supports, with a `when` expression where it takes one. From `examples/AiGovernanceList/advanced.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AiGovernanceList.schema.json
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: unapproved-mcp
  labels:
    team: platform-security
  annotations:
    ticket: https://tracker.example.com/SEC-2214
spec:
  family: mcp
  list: deny
  action: strip
  priority: 20
  enabled: true
  patterns:
    - "*-shell"
    - filesystem
---
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: approved-skills
spec:
  family: skill
  list: allow
  action: flag
  priority: 100
  enabled: false
  patterns:
    - code-review
    - "acme-*"
```

**HCL** (resource `vulnetix_ai_governance_list`)

```hcl
# Every argument the kind supports. From config-schemas examples/AiGovernanceList/advanced.yaml.

resource "vulnetix_ai_governance_list" "unapproved_mcp" {
  name     = "unapproved-mcp"
  action   = "strip"
  enabled  = true
  family   = "mcp"
  list     = "deny"
  patterns = ["*-shell", "filesystem"]
  priority = 20
  labels = {
    team = "platform-security"
  }
  annotations = {
    ticket = "https://tracker.example.com/SEC-2214"
  }
}

resource "vulnetix_ai_governance_list" "approved_skills" {
  name     = "approved-skills"
  action   = "flag"
  enabled  = false
  family   = "skill"
  list     = "allow"
  patterns = ["code-review", "acme-*"]
  priority = 100
}
```

Every field that has a schema default, set to that default: [`terraform/ai_governance_list.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/ai_governance_list.tf) and [`yaml/AiGovernanceList.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/AiGovernanceList.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AiGovernanceList.schema.json
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: unapproved-mcp
  labels:
    team: platform-security
  annotations:
    ticket: https://tracker.example.com/SEC-2214
spec:
  family: mcp
  list: deny
  action: strip
  priority: 20
  enabled: true
  patterns:
    - "*-shell"
    - filesystem
---
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: approved-skills
spec:
  family: skill
  list: allow
  action: flag
  priority: 100
  enabled: false
  patterns:
    - code-review
    - "acme-*"
EOF
```

## Fields

Paths use dots for nesting and `[]` for the items of a list. **Required** means required whenever the parent object is present. A default is what the server uses when the field is left out.

| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| <span id="apiVersion"></span>`apiVersion` | string | yes |  | exactly `vulnetix.com/v1` | The document format version. Every kind in this release is vulnetix.com/v1. |
| <span id="kind"></span>`kind` | string | yes |  | exactly `AiGovernanceList` | Always AiGovernanceList. |
| <span id="metadata"></span>`metadata` | object | yes |  | no other keys |  |
| <span id="metadata-name"></span>`metadata.name` | string | yes |  | pattern `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$` | The object's name, unique per kind within a tenant. It is the natural key: plan, apply, export and the Terraform provider all address an object by kind and name. |
| <span id="metadata-org"></span>`metadata.org` | string | no |  | format `uuid` | The tenant (organization UUID) the document belongs to. When set, plan and apply refuse to run against any other tenant. |
| <span id="metadata-labels"></span>`metadata.labels` | object | no |  | map of string to string (length 0 to 256); keys match `^[a-z0-9]([a-z0-9._/-]{0,61}[a-z0-9])?$` | Free key/value labels. Stored with the object, never interpreted by the server. |
| <span id="metadata-annotations"></span>`metadata.annotations` | object | no |  | map of string to string (length 0 to 4096) | Free key/value notes for people and tools, such as a ticket link. |
| <span id="spec"></span>`spec` | object | yes |  | no other keys | An allow or deny list for one AI capability family. Each pattern becomes one AI Firewall guardrail row of rule type <family>_<list> (tool_deny, mcp_allow and so on). A deny always wins. Any enabled allow rule puts its family into allowlist mode, where everything it does not name is refused. |
| <span id="spec-family"></span>`spec.family` | string | yes |  | `tool`, `mcp`, `skill`, `client` | tool: a tool offered to the model. mcp: an MCP server wired into the session. skill: an agent skill. client: the calling client, named by its headers (claude-code, codex-cli). |
| <span id="spec-list"></span>`spec.list` | string | yes |  | `allow`, `deny` |  |
| <span id="spec-action"></span>`spec.action` | string | yes |  | `block`, `flag`, `strip` | block refuses the request. flag lets it through and records the match. strip removes the matched tool or MCP server and sends the rest of the request; it applies to the tool and mcp families only, because a skill is a value inside another tool and a client is a header. |
| <span id="spec-priority"></span>`spec.priority` | integer | no | `100` | >= 0 | Evaluation order among guardrails, lowest first. |
| <span id="spec-enabled"></span>`spec.enabled` | boolean | no | `true` |  |  |
| <span id="spec-patterns"></span>`spec.patterns` | array of string | yes |  | 1 to any items; items unique; each item: pattern `^[^\^\s](.*[^$\s])?$`; length 1 to any |  |

## Rules

Conditions the schema enforces beyond each field's own type. `vulnetix config validate` and the engine's plan report a document that breaks one.

| On | Rule |
|---|---|
| `spec` | When `family` is one of `skill`, `client`: `action` must be `block`, `flag`. |

## Applying this kind

- **Command.** `vulnetix config apply -f <file>`; the CLI line above says from which release. Plan first with [`vulnetix config plan`](/platform-iac/cli/plan.md): it shows each object as create, update, delete or no change, with a `planHash` that apply then holds to. Apply writes in one transaction.
- **Manager.** Each object records the manager that applied it (`terraform`, `console` or `gitops:<repo>`). `--prune` deletes only objects its own manager owns. See [The manager](/platform-iac/cli/plan.md#the-manager) and the [config engine](/platform-iac/reference/engine.md).
- **Status.** Applied, Unchanged or Deleted, with no other status fields. The phases the engine reports are explained under [status phases](/platform-iac/reference/engine.md#status-phases).

## How it is stored

Each pattern becomes one AI Firewall guardrail row of rule type `<family>_<list>` (`tool_deny`, `mcp_allow` and so on), owned by the list (`configOwner = "AiGovernanceList/<name>"`). Removing a pattern removes its row, and rows written in the Resolve Platform are never touched. [`AiFirewallPolicy`](/platform-iac/kinds/ai-firewall-policy.md) `spec.capabilities` writes the same kind of rows, owned by the policy.

## Terraform and OpenTofu

The resource is `vulnetix_ai_governance_list` in the `vulnetix/resolve` provider. Its arguments are the `spec` in snake case, beside `name`, `labels` and `annotations` from `metadata`. The Minimal and Advanced HCL are above. The provider's own reference is [vulnetix_ai_governance_list](https://registry.terraform.io/providers/vulnetix/resolve/latest/docs/resources/ai_governance_list).

Import an object that already exists by its name:

```shell
# Import an existing AiGovernanceList by its name (metadata.name).
terraform import vulnetix_ai_governance_list.deny_shell_tools deny-shell-tools
```

Install, authentication and how state is read: [Terraform and OpenTofu](/platform-iac/terraform.md).

## More examples

`examples/AiGovernanceList/deny-mcp.yaml` from `Vulnesis/config-schemas`:

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AiGovernanceList.schema.json
apiVersion: vulnetix.com/v1
kind: AiGovernanceList
metadata:
  name: unapproved-mcp
spec:
  family: mcp
  list: deny
  action: strip
  priority: 20
  patterns:
    - "*-shell"
    - filesystem
```

Check a file with `vulnetix config validate -f <file>`. See [Validate documents](/platform-iac/cli/validate.md). In an editor, start the file with the [schema comment](/platform-iac/schemas/editors.md).
