Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Vault

The logical entity where the Vault service creates and durably stores keys.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains this vault.

cryptoEndpoint

cryptoEndpoint: string

The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey 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: {@code {"Operations": {"CostCenter": "42"}}}

displayName

displayName: string

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

Optional externalKeyManagerMetadataSummary

externalKeyManagerMetadataSummary: model.ExternalKeyManagerMetadataSummary

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the vault.

Optional isPrimary

isPrimary: undefined | false | true

A Boolean value that indicates whether the Vault is primary Vault or replica Vault.

lifecycleState

lifecycleState: LifecycleState

The vault's current lifecycle state.

Example: {@code DELETED}

managementEndpoint

managementEndpoint: string

The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.

Optional replicaDetails

replicaDetails: model.VaultReplicaDetails

Optional restoredFromVaultId

restoredFromVaultId: undefined | string

The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.

timeCreated

timeCreated: Date

The date and time this vault was created, expressed in RFC 3339 timestamp format.

Example: {@code 2018-04-03T21:10:29.600Z}

Optional timeOfDeletion

timeOfDeletion: Date

An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: {@code 2018-04-03T21:10:29.600Z}

vaultType

vaultType: VaultType

The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

wrappingkeyId

wrappingkeyId: string

The OCID of the vault's wrapping key.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Vault): object

getJsonObj

  • getJsonObj(obj: Vault): object