Skip to content

Identity: Compartment

Manage OCI IAM compartments. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot

Field Value
Service identity
Resource Compartment
API Version identity.oracle.com/v1beta1
Package Identity
Support Status Preview
Latest Released Version v2.0.0-alpha
Install Namespace oci-service-operator-identity-system

Spec Fields

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
compartmentId The OCID of the parent compartment containing the compartment. string Yes
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No
description The description you assign to the compartment during creation. Does not have to be unique, and it's changeable. string Yes
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No
name The name you assign to the compartment during creation. The name must be unique across all compartments in the parent compartment. Avoid entering confidential information. string Yes

Status Fields

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
compartmentId The OCID of the parent compartment containing the compartment. string No
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No
description The description you assign to the compartment. Does not have to be unique, and it's changeable. string No
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No
id The OCID of the compartment. string No
inactiveStatus The detailed status of INACTIVE lifecycleState. integer (int64) No
isAccessible Indicates whether or not the compartment is accessible for the user making the request. Returns true when the user has INSPECT permissions directly on a resource in the compartment or indirectly (permissions can be on a resource in a subcompartment). boolean No
lifecycleState The compartment's current state. After creating a compartment, make sure its lifecycleState changes from CREATING to ACTIVE before using it. string No
name The name you assign to the compartment during creation. The name must be unique across all compartments in the parent. Avoid entering confidential information. string No
status - object Yes
timeCreated Date and time the compartment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z string No

Sample Manifest

This example is generated from the checked-in sample manifest at config/samples/identity_v1beta1_compartment.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#

apiVersion: identity.oracle.com/v1beta1
kind: Compartment
metadata:
  name: compartment-sample
spec: {}