ResponderRecipe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-responder-recipe-schema.json",
  "title": "ResponderRecipe",
  "description": "A ResponderRecipe resource contains a specific instance of one of\nthe supported detector types (for example, activity, configuration,\nor threat).\n\nA ResponderRecipe resource:\n* Is effectively a copy of a Responder resource in which users can make\nvery limited changes if it’s Oracle-managed, and more changes if it’s user-managed.\n* Can also be created by cloning an existing ResponderRecipe resource, either\nuser-managed or Oracle-managed.\n* Is visible on Cloud Guard’s Responder Recipes page.\n* Is located in a specific OCI compartment.\n* Can be modified by users, programmatically or through the UI.\n* Changes that can be made here apply globally, to resources in all OCI compartments\nmapped to a target that attaches the responder recipe, but are overridden by\nany changes made in the corresponding TargetResponderRecipe resource (effectively\ncreated when the responder recipe is attached to the target).\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-cloudguard-api-openapi.yml#/components/schemas/ResponderRecipe",
  "properties": {
    "compartmentId": {
      "description": "Compartment OCID",
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n\nAvoid entering confidential information.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "Responder recipe description",
      "type": "string"
    },
    "displayName": {
      "description": "Responder recipe display name",
      "type": "string"
    },
    "effectiveResponderRules": {
      "description": "List of currently enabled responder rules for the responder type, for recipe after applying defaults",
      "items": {
        "$ref": "#/$defs/ResponderRecipeResponderRule"
      },
      "type": "array"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n\nAvoid entering confidential information.\n",
      "type": "object"
    },
    "id": {
      "description": "Unique identifier for the responder recip",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "lifecycleDetails": {
      "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current lifecycle state of the example",
      "enum": [
        "CREATING",
        "UPDATING",
        "ACTIVE",
        "INACTIVE",
        "DELETING",
        "DELETED",
        "FAILED"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/LifecycleState"
    },
    "owner": {
      "description": "Owner of responder recipe",
      "enum": [
        "CUSTOMER",
        "ORACLE"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/OwnerType"
    },
    "responderRules": {
      "description": "List of responder rules associated with the recipe",
      "items": {
        "$ref": "#/$defs/ResponderRecipeResponderRule"
      },
      "type": "array"
    },
    "sourceResponderRecipeId": {
      "description": "The unique identifier of the source responder recipe",
      "type": "string"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n\nAvoid entering confidential information.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "type": "object"
      },
      "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nSystem tags can be viewed by users, but can only be created by the system.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "timeCreated": {
      "description": "The date and time the responder recipe was created. Format defined by RFC3339.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId"
  ],
  "type": "object",
  "$defs": {
    "Condition": {
      "description": "The base condition resource.",
      "properties": {
        "kind": {
          "description": "Type of condition resource",
          "enum": [
            "COMPOSITE",
            "SIMPLE"
          ],
          "type": "string"
        }
      },
      "required": [
        "kind"
      ]
    },
    "ResourceLock": {
      "description": "Resource locks are used to prevent certain APIs from being called for the resource.\nA full lock prevents both updating the resource and deleting the resource. A delete\nlock prevents deleting the resource.\n",
      "properties": {
        "message": {
          "description": "A message added by the creator of the lock. This is typically used to give an\nindication of why the resource is locked.\n",
          "type": "string"
        },
        "relatedResourceId": {
          "description": "The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n",
          "type": "string"
        },
        "timeCreated": {
          "description": "When the lock was created, in the format defined by RFC 3339.",
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "description": "Type of the lock.",
          "enum": [
            "FULL",
            "DELETE"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "ResponderConfiguration": {
      "description": "Details for a configuration to be applied to a responder.",
      "properties": {
        "configKey": {
          "description": "Unique identifier of the configuration",
          "type": "string"
        },
        "name": {
          "description": "Configuration name",
          "type": "string"
        },
        "value": {
          "description": "Configuration value",
          "type": "string"
        }
      },
      "required": [
        "configKey",
        "name",
        "value"
      ],
      "type": "object"
    },
    "ResponderRecipeResponderRule": {
      "description": "A ResponderRecipeRule resource contains a specific instance of a\nsingle responder rule.\n\nA ResponderRecipeRule resource:\n* Is effectively a copy of a ResponderRule resource in which users can\nmake certain changes if it’s Oracle-managed, and other changes if it’s user-managed.\n* Can also be created by cloning an existing ResponderRecipe resource, either\nuser-managed or Oracle-managed; cloning the ResponderRecipe resource also clones\nits associated ResponderRule resources as ResponderRecipeRule resources.\n* Is visible on the Cloud Guard Responder Recipes, Responder Details page.\n* Is effectively located in a specific OCI compartment, through the ResponderRecipe\nresource to which it belongs.\n* Can be modified by users, programmatically or through the UI.\n* Changes that can be made here apply globally, to all resources in OCI compartments\nmapped to a target that attaches the associated responder recipe (in a\nTargetResponderRecipe resource), but are overridden by changes made in the\ncorresponding TargetResponderRecipe resource (which is effectively a copy of the\nResponderRecipe resource).\ntype: object\n",
      "properties": {
        "compartmentId": {
          "description": "Compartment OCID",
          "type": "string"
        },
        "description": {
          "description": "Responder rule description",
          "type": "string"
        },
        "details": {
          "$ref": "#/$defs/ResponderRuleDetails"
        },
        "displayName": {
          "description": "Responder rule display name",
          "type": "string"
        },
        "lifecycleDetails": {
          "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
          "type": "string"
        },
        "lifecycleState": {
          "description": "The current lifecycle state of the responder rule",
          "enum": [
            "CREATING",
            "UPDATING",
            "ACTIVE",
            "INACTIVE",
            "DELETING",
            "DELETED",
            "FAILED"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/LifecycleState"
        },
        "locks": {
          "description": "Locks associated with this resource.",
          "items": {
            "$ref": "#/$defs/ResourceLock"
          },
          "maxItems": 1,
          "type": "array"
        },
        "policies": {
          "description": "List of policies",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "responderRuleId": {
          "description": "Unique identifier for the responder rule",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "supportedModes": {
          "description": "Supported execution modes for the responder rule",
          "items": {
            "enum": [
              "AUTOACTION",
              "USERACTION"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "timeCreated": {
          "description": "The date and time the responder recipe rule was created. Format defined by RFC3339.",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "The date and time the responder recipe rule was last updated. Format defined by RFC3339.",
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "description": "Type of responder",
          "enum": [
            "REMEDIATION",
            "NOTIFICATION"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/ResponderType"
        }
      },
      "required": [
        "responderRuleId",
        "compartmentId"
      ]
    },
    "ResponderRuleDetails": {
      "description": "Detailed information for a responder rule",
      "properties": {
        "condition": {
          "$ref": "#/$defs/Condition"
        },
        "configurations": {
          "description": "List of responder rule configurations",
          "items": {
            "$ref": "#/$defs/ResponderConfiguration"
          },
          "type": "array"
        },
        "isEnabled": {
          "description": "Enabled state for the responder rule",
          "type": "boolean"
        },
        "mode": {
          "description": "Execution mode for the responder rule",
          "enum": [
            "AUTOACTION",
            "USERACTION"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/ResponderModeTypes"
        }
      },
      "required": [
        "isEnabled"
      ],
      "type": "object"
    }
  }
}