Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ImportKeyDetails

The details of the Key that you wish to import.

Properties

Optional autoKeyRotationDetails

autoKeyRotationDetails: model.AutoKeyRotationDetails

compartmentId

compartmentId: string

The OCID of the compartment that contains this key.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "foo-value"}}}

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

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional isAutoRotationEnabled

isAutoRotationEnabled: undefined | false | true

A parameter specifying whether the auto key rotation is enabled or not.

keyShape

keyShape: KeyShape

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 {@code 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 {@code 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 {@code SOFTWARE} are performed on the server. By default, a key's protection mode is set to {@code HSM}. You can't change a key's protection mode after the key is created or imported.

wrappedImportKey

wrappedImportKey: WrappedImportKey

Functions

getDeserializedJsonObj

getJsonObj