Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace KeySummary

Properties

Optional algorithm

algorithm: Algorithm

The algorithm used by a key's key versions to encrypt or decrypt data.

compartmentId

compartmentId: string

The OCID of the compartment that contains the key.

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.

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.

timeCreated

timeCreated: Date

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

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

vaultId

vaultId: string

The OCID of the vault that contains the key.

Functions

getJsonObj