Skip to content

lockbox.oracle.com/v1beta1

Back to API Reference

APIVersion: lockbox.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

No customer-visible package currently exposes lockbox.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
ApprovalTemplate Namespaced Sample -
Lockbox Namespaced Sample -

ApprovalTemplate

ApprovalTemplate is the Schema for the approvaltemplates API.

  • Plural: approvaltemplates
  • Scope: Namespaced
  • APIVersion: lockbox.oracle.com/v1beta1
  • Sample: Sample (config/samples/lockbox_v1beta1_approvaltemplate.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ApprovalTemplateSpec defines the desired state of ApprovalTemplate.

Field Description Type Required Default Enum
approverLevels ApprovalTemplateApproverLevels defines nested fields for ApprovalTemplate.ApproverLevels. object No - -
autoApprovalState The auto approval state of the lockbox. string No - -
compartmentId The unique identifier (OCID) of the compartment where the resource is located. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName approval template identifier string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -

Spec.approverLevels

Back to ApprovalTemplate spec

ApprovalTemplateApproverLevels defines nested fields for ApprovalTemplate.ApproverLevels.

Field Description Type Required Default Enum
level1 ApprovalTemplateApproverLevelsLevel1 defines nested fields for ApprovalTemplate.ApproverLevels.Level1. object Yes - -
level2 ApprovalTemplateApproverLevelsLevel2 defines nested fields for ApprovalTemplate.ApproverLevels.Level2. object No - -
level3 ApprovalTemplateApproverLevelsLevel3 defines nested fields for ApprovalTemplate.ApproverLevels.Level3. object No - -

Spec.approverLevels.level1

Back to ApprovalTemplate spec

ApprovalTemplateApproverLevelsLevel1 defines nested fields for ApprovalTemplate.ApproverLevels.Level1.

Field Description Type Required Default Enum
approverId The group or user ocid of the approver for this approver level. string Yes - -
approverType The approver type of this approver level. string Yes - -
domainId The identity domain ocid of the approver. string No - -

Spec.approverLevels.level2

Back to ApprovalTemplate spec

ApprovalTemplateApproverLevelsLevel2 defines nested fields for ApprovalTemplate.ApproverLevels.Level2.

Field Description Type Required Default Enum
approverId The group or user ocid of the approver for this approver level. string Yes - -
approverType The approver type of this approver level. string Yes - -
domainId The identity domain ocid of the approver. string No - -

Spec.approverLevels.level3

Back to ApprovalTemplate spec

ApprovalTemplateApproverLevelsLevel3 defines nested fields for ApprovalTemplate.ApproverLevels.Level3.

Field Description Type Required Default Enum
approverId The group or user ocid of the approver for this approver level. string Yes - -
approverType The approver type of this approver level. string Yes - -
domainId The identity domain ocid of the approver. string No - -

Status

ApprovalTemplateStatus defines the observed state of ApprovalTemplate.

Field Description Type Required Default Enum
approverLevels ApprovalTemplateApproverLevels defines nested fields for ApprovalTemplate.ApproverLevels. object No - -
autoApprovalState The auto approval state of the lockbox. string No - -
compartmentId The unique identifier (OCID) of the customer compartment where the approval template is located. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName The approval template display name. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id The unique identifier (OCID) of the approval template, which can't be changed after creation. string No - -
lifecycleState The current state of the approval template. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the the approval template was created. An RFC3339 formatted datetime string string No - -
timeUpdated The time the approval template was updated. An RFC3339 formatted datetime string string No - -

Status.approverLevels

Back to ApprovalTemplate status

ApprovalTemplateApproverLevels defines nested fields for ApprovalTemplate.ApproverLevels.

Field Description Type Required Default Enum
level1 ApprovalTemplateApproverLevelsLevel1 defines nested fields for ApprovalTemplate.ApproverLevels.Level1. object Yes - -
level2 ApprovalTemplateApproverLevelsLevel2 defines nested fields for ApprovalTemplate.ApproverLevels.Level2. object No - -
level3 ApprovalTemplateApproverLevelsLevel3 defines nested fields for ApprovalTemplate.ApproverLevels.Level3. object No - -

Status.approverLevels.level1

Back to ApprovalTemplate status

ApprovalTemplateApproverLevelsLevel1 defines nested fields for ApprovalTemplate.ApproverLevels.Level1.

Field Description Type Required Default Enum
approverId The group or user ocid of the approver for this approver level. string Yes - -
approverType The approver type of this approver level. string Yes - -
domainId The identity domain ocid of the approver. string No - -

Status.approverLevels.level2

Back to ApprovalTemplate status

ApprovalTemplateApproverLevelsLevel2 defines nested fields for ApprovalTemplate.ApproverLevels.Level2.

Field Description Type Required Default Enum
approverId The group or user ocid of the approver for this approver level. string Yes - -
approverType The approver type of this approver level. string Yes - -
domainId The identity domain ocid of the approver. string No - -

Status.approverLevels.level3

Back to ApprovalTemplate status

ApprovalTemplateApproverLevelsLevel3 defines nested fields for ApprovalTemplate.ApproverLevels.Level3.

Field Description Type Required Default Enum
approverId The group or user ocid of the approver for this approver level. string Yes - -
approverType The approver type of this approver level. string Yes - -
domainId The identity domain ocid of the approver. string No - -

Status.status

Back to ApprovalTemplate 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 ApprovalTemplate 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 ApprovalTemplate 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 ApprovalTemplate status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Lockbox

Lockbox is the Schema for the lockboxes API.

  • Plural: lockboxes
  • Scope: Namespaced
  • APIVersion: lockbox.oracle.com/v1beta1
  • Sample: Sample (config/samples/lockbox_v1beta1_lockbox.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

LockboxSpec defines the desired state of Lockbox.

Field Description Type Required Default Enum
accessContextAttributes LockboxAccessContextAttributes defines nested fields for Lockbox.AccessContextAttributes. object Yes - -
approvalTemplateId Approval template ID string No - -
compartmentId The unique identifier (OCID) of the compartment where the resource is located. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Lockbox Identifier string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
lockboxPartner The partner using this lockbox to lock a resource. string No - -
maxAccessDuration The maximum amount of time operator has access to associated resources. string No - -
partnerCompartmentId Compartment Identifier string No - -
partnerId The unique identifier (OCID) of partner resource using this lockbox to lock a resource string No - -
resourceId The unique identifier (OCID) of the customer's resource. string Yes - -

Spec.accessContextAttributes

Back to Lockbox spec

LockboxAccessContextAttributes defines nested fields for Lockbox.AccessContextAttributes.

Field Description Type Required Default Enum
items List of context attributes. list[object] Yes - -

Spec.accessContextAttributes.items[]

Back to Lockbox spec

LockboxAccessContextAttributesItem defines nested fields for Lockbox.AccessContextAttributes.Item.

Field Description Type Required Default Enum
defaultValue An optional default value used when access request context value is not provided string No - -
description The description of the context attribute string No - -
name The name of the context attribute string Yes - -
values List of context attribute values. list[string] No - -

Status

LockboxStatus defines the observed state of Lockbox.

Field Description Type Required Default Enum
accessContextAttributes LockboxAccessContextAttributes defines nested fields for Lockbox.AccessContextAttributes. object No - -
approvalTemplateId Approval template ID string No - -
compartmentId Compartment Identifier string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Lockbox Identifier, can be renamed string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id Unique identifier that is immutable on creation string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current state of the Lockbox. string No - -
lockboxPartner The partner using this lockbox to lock a resource. string No - -
maxAccessDuration The maximum amount of time operator has access to associated resources. string No - -
parentLockboxId The unique identifier (OCID) of lockbox resource using to reference parent lockbox in hybrid oma setup string No - -
partnerCompartmentId Compartment Identifier string No - -
partnerId The unique identifier (OCID) of partner resource using this lockbox to lock a resource string No - -
resourceId The unique identifier (OCID) of associated resource that the lockbox is created for. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the the Lockbox was created. An RFC3339 formatted datetime string string No - -
timeUpdated The time the Lockbox was updated. An RFC3339 formatted datetime string string No - -

Status.accessContextAttributes

Back to Lockbox status

LockboxAccessContextAttributes defines nested fields for Lockbox.AccessContextAttributes.

Field Description Type Required Default Enum
items List of context attributes. list[object] Yes - -

Status.accessContextAttributes.items[]

Back to Lockbox status

LockboxAccessContextAttributesItem defines nested fields for Lockbox.AccessContextAttributes.Item.

Field Description Type Required Default Enum
defaultValue An optional default value used when access request context value is not provided string No - -
description The description of the context attribute string No - -
name The name of the context attribute string Yes - -
values List of context attribute values. list[string] No - -

Status.status

Back to Lockbox 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 Lockbox 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 Lockbox 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 Lockbox status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -