identity.oracle.com/v1beta1
Back to API Reference
APIVersion: identity.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
| Package |
Support |
Latest release |
Resources |
| Identity |
preview |
v2.0.0-alpha |
Compartment |
Resources
Compartment
Manage OCI IAM compartments.
Plural: compartmentsScope: NamespacedAPIVersion: identity.oracle.com/v1beta1Sample: Sample (config/samples/identity_v1beta1_compartment.yaml)Packages: Identity (v2.0.0-alpha)
Spec
CompartmentSpec defines the desired state of Compartment.
| Field |
Description |
Type |
Required |
Default |
Enum |
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
CompartmentStatus defines the observed state of Compartment.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
Status.status
Back to Compartment status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Compartment status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Compartment status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Compartment status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |