# ServiceAccount

A credential for CI that is not a person. Fields, YAML, HCL and CLI samples, and how apply treats it.

A credential for CI that is not a person. It is named after the organisation, as <organisation>:<metadata.name>, has no email address and cannot sign in. It holds the member role unless spec.role says developer or owner. A member cannot invite people, mint further credentials or change policy. A developer service account can plan, apply and export every kind, ServiceAccount included, and so is the credential to give Terraform or CI that applies Platform IaC. An owner service account can do everything an owner can. Applying a new ServiceAccount creates it and returns its API key and secret once, in the apply result's status (status.apiKey and status.secret): they are never shown again, by plan, export or the console, so store them as the apply returns them. Applying needs an owner, an admin or a developer. Only an owner can declare an owner; a developer declares member or developer service accounts and cannot change or delete an owner one. Deleting the document deactivates the service account, so its key stops working; it is kept for the audit trail, and its name cannot be used again.

| | |
|---|---|
| `apiVersion` | `vulnetix.com/v1` |
| `kind` | `ServiceAccount` |
| Group | [Org](/platform-iac/kinds/catalogue.md#org) |
| 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 person or service account with the developer role, or an Authentik access token for either. As code a developer grants up to developer and cannot change or remove an owner; in the console only an owner manages this kind. A member is refused with HTTP 403. See [Credentials for automation](/platform-iac/reference/config-api.md#credentials-for-automation). |
| Terraform resource | [`vulnetix_service_account`](/platform-iac/terraform/resources.md#vulnetix_service_account), 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/ServiceAccount.schema.json`](https://github.com/Vulnesis/config-schemas/releases/download/v1.19.1/ServiceAccount.schema.json) |
| Newest schema | [`latest/ServiceAccount.schema.json`](https://github.com/Vulnesis/config-schemas/releases/latest/download/ServiceAccount.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 ServiceAccount` |

## Minimal

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

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/ServiceAccount.schema.json
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: ci-scanner
spec: {}
```

**HCL** (resource `vulnetix_service_account`)

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

resource "vulnetix_service_account" "ci_scanner" {
  name = "ci-scanner"
}
```

Every field that has a schema default, set to that default: [`terraform/service_account.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/service_account.tf) and [`yaml/ServiceAccount.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/ServiceAccount.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/ServiceAccount.schema.json
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: ci-scanner
spec: {}
EOF
```

## Advanced

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

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/ServiceAccount.schema.json
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: ci-scanner
  labels:
    pipeline: github-actions
  annotations:
    owner: platform-team
spec:
  role: member
---
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: terraform-apply
spec:
  role: developer
---
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: release-signer
spec: {}
```

**HCL** (resource `vulnetix_service_account`)

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

resource "vulnetix_service_account" "ci_scanner" {
  name = "ci-scanner"
  role = "member"
  labels = {
    pipeline = "github-actions"
  }
  annotations = {
    owner = "platform-team"
  }
}

resource "vulnetix_service_account" "terraform_apply" {
  name = "terraform-apply"
  role = "developer"
}

resource "vulnetix_service_account" "release_signer" {
  name = "release-signer"
}
```

Every field that has a schema default, set to that default: [`terraform/service_account.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/service_account.tf) and [`yaml/ServiceAccount.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/ServiceAccount.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/ServiceAccount.schema.json
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: ci-scanner
  labels:
    pipeline: github-actions
  annotations:
    owner: platform-team
spec:
  role: member
---
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: terraform-apply
spec:
  role: developer
---
apiVersion: vulnetix.com/v1
kind: ServiceAccount
metadata:
  name: release-signer
spec: {}
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 `ServiceAccount` | Always ServiceAccount. |
| <span id="metadata"></span>`metadata` | object | yes |  | no other keys | The name is 3 to 40 lowercase letters, digits and hyphens, such as ci-scanner. |
| <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 | A service account declares its name and, optionally, its role. |
| <span id="spec-role"></span>`spec.role` | string | no | `member` | `member`, `developer`, `owner`, `admin` | member, developer or owner. member (the default) can scan and read but cannot change policy. developer can apply Platform IaC for every kind, service accounts up to developer included, but in the console cannot manage members, invitations, billing, the vault, service accounts or Drift protection: it is the credential to give Terraform or CI. owner can do everything an owner can. Only an owner may declare owner; an owner or a developer may declare developer. admin is a retired role that a person can no longer be given and a service account cannot hold: the schema still accepts the word so that documents written for v1.16.0 validate, and applying one is refused. |

## 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.** `status.principal`, `status.apiKey` and `status.secret`, in the apply that creates it and never again. The phases the engine reports are explained under [status phases](/platform-iac/reference/engine.md#status-phases).

## How apply treats it

- The spec is empty. The account is always a member.
- Apply returns `status.principal`, `status.apiKey` and `status.secret` once. Plan, export and later applies never show them. Store them as the apply returns them.
- A name that belonged to a deleted account is refused, active or not.
- A create that rolls back deletes the Authentik user it made. A deactivation that rolls back reactivates it.
- Delete deactivates. Secret rotation is not declarable yet: the Resolve Platform's rotate endpoint stays the way to rotate.
- Owner only. A service account with the developer role cannot apply this kind.

## Terraform and OpenTofu

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

Import an object that already exists by its name:

```shell
# Import an existing ServiceAccount by its name (metadata.name).
terraform import vulnetix_service_account.ci_scanner ci-scanner
```

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