CreateAnalyticsInstanceDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-create-analytics-instance-details-schema.json",
  "title": "CreateAnalyticsInstanceDetails",
  "description": "Input payload to create an Anaytics instance.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-analytics-api-openapi.yml#/components/schemas/CreateAnalyticsInstanceDetails",
  "properties": {
    "adminUser": {
      "description": "user name of the authorized user.\n",
      "maxLength": 255,
      "type": "string"
    },
    "capacity": {
      "$ref": "#/$defs/Capacity"
    },
    "compartmentId": {
      "description": "The OCID of the compartment.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "Optional description.\n",
      "maxLength": 512,
      "minLength": 0,
      "type": "string"
    },
    "domainId": {
      "description": "domain id for which the user is authorized.\n",
      "maxLength": 255,
      "type": "string"
    },
    "emailNotification": {
      "description": "Email address receiving notifications.\n",
      "maxLength": 512,
      "minLength": 0,
      "type": "string"
    },
    "featureBundle": {
      "description": "The feature set of an Analytics instance.\n",
      "enum": [
        "FAW_PAID",
        "FAW_FREE",
        "EE_EMBEDDED",
        "SE_EMBEDDED"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/FeatureBundle"
    },
    "featureSet": {
      "description": "Analytics feature set.\n",
      "enum": [
        "SELF_SERVICE_ANALYTICS",
        "ENTERPRISE_ANALYTICS"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/FeatureSet"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no\npredefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "idcsAccessToken": {
      "description": "IDCS access token identifying a stripe and service administrator user.\n",
      "maxLength": 8192,
      "type": "string"
    },
    "kmsKeyId": {
      "description": "OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.\n",
      "maxLength": 255,
      "minLength": 0,
      "type": "string"
    },
    "licenseType": {
      "description": "The license used for the service.\n",
      "enum": [
        "LICENSE_INCLUDED",
        "BRING_YOUR_OWN_LICENSE"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/LicenseType"
    },
    "name": {
      "description": "The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.\n",
      "maxLength": 32,
      "minLength": 1,
      "pattern": "^[a-zA-Z](-?[a-zA-Z0-9])*$",
      "type": "string"
    },
    "networkEndpointDetails": {
      "$ref": "#/$defs/NetworkEndpointDetails"
    },
    "updateChannel": {
      "description": "Analytics instance update channel.\n",
      "enum": [
        "REGULAR",
        "EARLY",
        "PHASE_2",
        "PHASE_1"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/UpdateChannel"
    }
  },
  "required": [
    "name",
    "compartmentId",
    "capacity",
    "featureSet",
    "licenseType"
  ],
  "$defs": {
    "Capacity": {
      "description": "Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).\n",
      "properties": {
        "capacityType": {
          "description": "The capacity model to use.\nAccepted values are:\nOLPU_COUNT, USER_COUNT\n",
          "enum": [
            "OLPU_COUNT",
            "USER_COUNT"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/CapacityType"
        },
        "capacityValue": {
          "description": "The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT).\nThis parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.\n",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "capacityType",
        "capacityValue"
      ],
      "type": "object"
    },
    "NetworkEndpointDetails": {
      "description": "Base representation of a network endpoint.\n",
      "properties": {
        "networkEndpointType": {
          "description": "The type of network endpoint.\n",
          "enum": [
            "PUBLIC",
            "PRIVATE"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/NetworkEndpointType"
        }
      },
      "required": [
        "networkEndpointType"
      ],
      "type": "object"
    }
  }
}