# WizConnection

The Wiz service account the tenant authorised. Fields, YAML, HCL and CLI samples, and how apply treats it.

The Wiz service account the tenant authorised. One per tenant. Wiz is connected as an addition to AWS: each claim Wiz makes is checked from inside the AWS account, so a plan is refused until AWS is connected, and on a plan without cloud integrations. Apply checks the credential against Wiz before it is stored, including that the service account can read audit data (admin:audit). The client secret is kept in the tenant's vault and is never exported, shown in a plan or returned by any endpoint. A connection is created and deleted, never edited: any change replaces it (the old connection is deleted and its stored secret revoked, then the new one is created and checked). Deleting the document disconnects Wiz and stops the sync; findings already ingested from Wiz, and their triage history, are kept.

| | |
|---|---|
| `apiVersion` | `vulnetix.com/v1` |
| `kind` | `WizConnection` |
| Group | [Integrations](/platform-iac/kinds/catalogue.md#integrations) |
| Status | **Served.** The [config engine](/platform-iac/reference/engine.md) plans and applies it. |
| Objects per tenant | one (`metadata.name: default`) |
| 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). |
| Secret fields | `spec.clientSecret`: read on the client from `valueFrom`, sent once, never exported or shown in a plan |
| Terraform resource | [`vulnetix_wiz_connection`](/platform-iac/terraform/resources.md#vulnetix_wiz_connection), imported by name (see [Terraform and OpenTofu](#terraform-and-opentofu)) |
| CLI | [`vulnetix config apply`](/platform-iac/cli/apply.md), CLI v3.168.0 and later. |
| Pinned schema | [`v1.19.1/WizConnection.schema.json`](https://github.com/Vulnesis/config-schemas/releases/download/v1.19.1/WizConnection.schema.json) |
| Newest schema | [`latest/WizConnection.schema.json`](https://github.com/Vulnesis/config-schemas/releases/latest/download/WizConnection.schema.json) |
| First released in | [`v1.5.0`](https://github.com/Vulnesis/config-schemas/releases/tag/v1.5.0) |
| Print the built-in copy | `vulnetix config schema WizConnection` |

## Minimal

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

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/WizConnection.schema.json
apiVersion: vulnetix.com/v1
kind: WizConnection
metadata:
  name: default
spec:
  clientId: 4ba3c9f2d7e14a6b8c0d1e2f3a4b5c6d
  tenantDatacenter: us17
```

**HCL** (resource `vulnetix_wiz_connection`)

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

resource "vulnetix_wiz_connection" "default" {
  client_id         = "4ba3c9f2d7e14a6b8c0d1e2f3a4b5c6d"
  tenant_datacenter = "us17"
}
```

Every field that has a schema default, set to that default: [`terraform/wiz_connection.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/wiz_connection.tf) and [`yaml/WizConnection.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/WizConnection.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/WizConnection.schema.json
apiVersion: vulnetix.com/v1
kind: WizConnection
metadata:
  name: default
spec:
  clientId: 4ba3c9f2d7e14a6b8c0d1e2f3a4b5c6d
  tenantDatacenter: us17
EOF
```

## Advanced

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

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/WizConnection.schema.json
# Connect AWS first: Wiz findings are verified from inside the account.
apiVersion: vulnetix.com/v1
kind: WizConnection
metadata:
  name: default
  labels:
    owner: cloud-security
  annotations:
    note: The service account needs the admin:audit permission.
spec:
  clientId: 4ba3c9f2d7e14a6b8c0d1e2f3a4b5c6d
  tenantDatacenter: us17
  clientSecret: { env: VULNESIS_WIZ_CLIENT_SECRET }
```

**HCL** (resource `vulnetix_wiz_connection`)

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

variable "default_client_secret" {
  type      = string
  sensitive = true
  ephemeral = true
}

resource "vulnetix_wiz_connection" "default" {
  client_id                = "4ba3c9f2d7e14a6b8c0d1e2f3a4b5c6d"
  client_secret_wo         = var.default_client_secret
  client_secret_wo_version = 1
  tenant_datacenter        = "us17"
  labels = {
    owner = "cloud-security"
  }
  annotations = {
    note = "The service account needs the admin:audit permission."
  }
}
```

Every field that has a schema default, set to that default: [`terraform/wiz_connection.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/wiz_connection.tf) and [`yaml/WizConnection.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/WizConnection.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
export VULNESIS_WIZ_CLIENT_SECRET=...   # read on this machine by valueFrom, never written to the document
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/WizConnection.schema.json
# Connect AWS first: Wiz findings are verified from inside the account.
apiVersion: vulnetix.com/v1
kind: WizConnection
metadata:
  name: default
  labels:
    owner: cloud-security
  annotations:
    note: The service account needs the admin:audit permission.
spec:
  clientId: 4ba3c9f2d7e14a6b8c0d1e2f3a4b5c6d
  tenantDatacenter: us17
  clientSecret: { env: VULNESIS_WIZ_CLIENT_SECRET }
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 | Secret | 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 `WizConnection` |  | Always WizConnection. |
| <span id="metadata"></span>`metadata` | object | yes |  | no other keys |  | Metadata for a kind the tenant has exactly one of. The name is fixed to default. |
| <span id="metadata-name"></span>`metadata.name` | string | yes |  | exactly `default`; 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 |  |  |
| <span id="spec-clientId"></span>`spec.clientId` | string | yes |  | pattern `^\S+$`; length 1 to 256 |  | The service account's client id, from Settings, Service Accounts in the Wiz console. |
| <span id="spec-tenantDatacenter"></span>`spec.tenantDatacenter` | string | yes |  | pattern `^[a-z0-9-]+$`; length 1 to 32 |  | The datacenter segment of the tenant's API host: us17 for api.us17.wiz.io. It is the part of the Wiz console URL before .wiz.io. |
| <span id="spec-clientSecret"></span>`spec.clientSecret` | object | no |  | 1 to 1 keys; no other keys | yes | Where the client reads the service account's client secret. Required when the connection is created; left out afterwards, the stored secret is kept, including when another change replaces the connection. |
| <span id="spec-clientSecret-env"></span>`spec.clientSecret.env` | string | no |  | pattern `^[A-Za-z_][A-Za-z0-9_]*$` |  | Name of an environment variable. |
| <span id="spec-clientSecret-file"></span>`spec.clientSecret.file` | string | no |  | length 1 to any |  | Path to a file holding the value. Trailing newlines are trimmed. |

## 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).
- **Singleton.** There is one per tenant, and its name is always `default`.

## How apply treats it

One per tenant. The Resolve Platform only creates and deletes a Wiz connection, so a change replaces it through those writers. The client secret is a `valueFrom` secret.

## Terraform and OpenTofu

The resource is `vulnetix_wiz_connection` 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_wiz_connection](https://registry.terraform.io/providers/vulnetix/resolve/latest/docs/resources/wiz_connection).

Import an object that already exists by its name (`default`):

```shell
# Import an existing WizConnection by its name (metadata.name).
terraform import vulnetix_wiz_connection.default default
```

A secret is two arguments, never stored in the plan or the state: `client_secret_wo` (write-only) and `client_secret_wo_version`. Change the version number to send a new value. See [Secrets](/platform-iac/terraform.md#secrets).

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

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