{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-cloud-platform/json-schema/google-cloud-platform-tag-key-schema.json",
  "title": "TagKey",
  "description": "A TagKey, used to group a set of TagValues.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-cloud-platform-cloudresourcemanager-tag-keys-api-openapi.yml#/components/schemas/TagKey",
  "properties": {
    "parent": {
      "type": "string",
      "description": "Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`."
    },
    "description": {
      "type": "string",
      "description": "Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write."
    },
    "createTime": {
      "type": "string",
      "format": "google-datetime",
      "description": "Output only. Creation time.",
      "readOnly": true
    },
    "allowedValuesRegex": {
      "description": "Optional. Regular expression constraint for freeform tag values. If present, it implicitly allows freeform values (constrained by the regex).",
      "type": "string"
    },
    "purpose": {
      "enum": [
        "PURPOSE_UNSPECIFIED",
        "GCE_FIREWALL",
        "DATA_GOVERNANCE"
      ],
      "description": "Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.",
      "type": "string"
    },
    "namespacedName": {
      "type": "string",
      "description": "Output only. Immutable. Namespaced name of the TagKey.",
      "readOnly": true
    },
    "updateTime": {
      "format": "google-datetime",
      "readOnly": true,
      "type": "string",
      "description": "Output only. Update time."
    },
    "shortName": {
      "description": "Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.",
      "type": "string"
    },
    "purposeData": {
      "type": "object",
      "description": "Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "name": {
      "type": "string",
      "description": "Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey."
    },
    "etag": {
      "type": "string",
      "description": "Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details."
    }
  },
  "type": "object"
}