Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Key

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains this master encryption key.

currentKeyVersion

currentKeyVersion: string

The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

displayName

displayName: string

A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

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. Example: {\"Department\": \"Finance\"}

id

id: string

The OCID of the key.

Optional isPrimary

isPrimary: undefined | false | true

keyShape

keyShape: KeyShape

lifecycleState

lifecycleState: LifecycleState

The key's current lifecycle state.

Example: `ENABLED`

Optional protectionMode

protectionMode: ProtectionMode

The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported.

Optional replicaDetails

replicaDetails: model.KeyReplicaDetails

Optional restoredFromKeyId

restoredFromKeyId: undefined | string

The OCID of the key from which this key was restored.

timeCreated

timeCreated: Date

The date and time the key was created, expressed in RFC 3339 timestamp format.

Example: `2018-04-03T21:10:29.600Z`

Optional timeOfDeletion

timeOfDeletion: Date

An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

vaultId

vaultId: string

The OCID of the vault that contains this key.

Functions

getJsonObj

  • getJsonObj(obj: Key): object