GovernanceInstance

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-governance-instance-schema.json",
  "title": "GovernanceInstance",
  "description": "The details of a GovernanceInstance.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-accessgovernancecp-api-openapi.yml#/components/schemas/GovernanceInstance",
  "properties": {
    "compartmentId": {
      "description": "The OCID of the compartment where the GovernanceInstance resides.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\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": "The description of the GovernanceInstance.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "displayName": {
      "description": "The name for the GovernanceInstance.",
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "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",
      "type": "object"
    },
    "id": {
      "description": "The unique OCID of the GovernanceInstance.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "instanceUrl": {
      "description": "The access URL of the GovernanceInstance.",
      "maxLength": 400,
      "minLength": 1,
      "type": "string"
    },
    "licenseType": {
      "description": "The license type of the instance.",
      "enum": [
        "AG_ORACLE_WORKLOADS",
        "AG_OCI",
        "AG_PREMIUM"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/LicenseType"
    },
    "lifecycleState": {
      "description": "The current state of the GovernanceInstance.",
      "enum": [
        "CREATING",
        "ACTIVE",
        "DELETING",
        "DELETED",
        "NEEDS_ATTENTION"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/InstanceLifecycleState"
    },
    "locks": {
      "description": "Locks associated with this resource.",
      "items": {
        "$ref": "#/$defs/ResourceLock"
      },
      "maxItems": 2,
      "type": "array"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "tenancyNamespace": {
      "description": "The namespace for tenancy object storage.",
      "maxLength": 400,
      "minLength": 1,
      "type": "string"
    },
    "timeCreated": {
      "description": "The time the the GovernanceInstance was created in an RFC3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the GovernanceInstance was updated in an RFC3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "compartmentId",
    "lifecycleState",
    "timeCreated",
    "displayName"
  ],
  "type": "object",
  "$defs": {
    "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": {
        "compartmentId": {
          "description": "The compartment ID of the lock.",
          "type": "string"
        },
        "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.",
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "description": "Type of the lock.",
          "enum": [
            "FULL",
            "DELETE"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    }
  }
}