Show / Hide Table of Contents

Namespace Oci.KeymanagementService.Models

Classes

AutoKeyRotationDetails

The details of auto rotation schedule for the Key being create updated or imported.

BackupKeyDetails

The details of the Key that you wish to backup.

BackupLocation

Backup upload location

BackupLocationBucket

Object storage bucket details to upload or download the backup

BackupLocationModelConverter

BackupLocationURI

PreAuthenticated object storage URI to upload or download the backup

BackupVaultDetails

The details of the Vault that you wish to backup.

ChangeHsmClusterCompartmentDetails

The details of the compartment you wish to move the hsm cluster to.

ChangeKeyCompartmentDetails

The deatils of the compartment that you wish to move the Key.

ChangeVaultCompartmentDetails

The details of the compartment you wish to move the Vault.

CreateEkmsPrivateEndpointDetails

Information needed to create EKMS private endpoint resource

CreateHsmClusterDetails

The details of the HSM cluster resource that you want to create.

CreateKeyDetails

The details of the key that you want to create.

CreateVaultDetails

The details of the vault that you want to create.

CreateVaultReplicaDetails

Creates a vault replica.

DecryptDataDetails

The details of the encrypted data that you want to decrypt.

DecryptedData

The response to a request to decrypt the encrypted data.

DeleteVaultReplicaDetails

Deletes a vault replica

EkmsPrivateEndpoint

EKMS private endpoint created in customer subnet used to connect to external key manager system

EkmsPrivateEndpointSummary

EKMS private endpoints summary

EncryptDataDetails

The details of the plaintext data that you want to encrypt.

EncryptedData

The response to a request to encrypt the plaintext data.

ExportKeyDetails

The details of the key that you want to wrap and export.

ExportedKeyData

The response to a request to export key material.

ExternalKeyManagerMetadata

Metadata required for accessing External Key manager

ExternalKeyManagerMetadataSummary

Summary about metadata of external key manager to be returned to the customer as a response.

ExternalKeyReference

A reference to the key on external key manager.

ExternalKeyReferenceDetails

Key reference data to be returned to the customer as a response.

ExternalKeyVersionReference

A reference to key version on external key manager.

GenerateKeyDetails

The details of the key that you want to encrypt or decrypt data.

GeneratedKey

The reponse to the regeuest to generate the key to encrypt or decrypt the data.

HsmCluster

Dedicated KMS-HSM Cluster Management

HsmClusterCollection

HsmClusterCollection object with page of HsmClusterSummary objects.

HsmClusterSummary

An object which encapsulates the details of a given HSM Cluster.

HsmPartition

Dedicated KMS-HSM Partition Management

HsmPartitionCollection

HsmPartitionCollection object with page of HsmPartitionSummary objects. A HsmPartitionSummary object contains details about the corresponding HSM.

HsmPartitionSummary

An object which encapsulates the details of a given HSM.

ImportKeyDetails

The details of the Key that you wish to import.

ImportKeyVersionDetails

The details of the KeyVersion that you wish to import.

Key

The logical entities that represent one or more key versions, each of which contains cryptographic material.

KeyReplicaDetails

Key replica details

KeyShape

The cryptographic properties of a key.

KeySummary

The details of the Key.

KeyVersion

The details of the KeyVersion associated with the Key.

KeyVersionReplicaDetails

KeyVersion replica details

KeyVersionSummary

The details of the KeyVersion.

OauthMetadata

Authorization details required to get access token from IDP for accessing protected resources.

OauthMetadataSummary

Summary about authorization to be returned to the customer as a response.

PortInformation

Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (this refers to either an enum value of Management Utility, Client Utility, or null)

PreCoUserCredentials

Pre Crypto officer user credentials.

ReplicaDetails

Details of replication status

ReplicaExternalVaultMetadata

Metadata of the replica region External Vault

ReplicaVaultMetadata

Metadata for the replica vault, needed if different from primary vault

ReplicaVaultMetadataModelConverter

ReplicationStatusDetails

Details of replication status across all replica regions

RestoreKeyFromObjectStoreDetails

The details of the backup location from which you want to restore the Key.

RestoreVaultFromObjectStoreDetails

The details of the backup location from which you want to restore the Vault.

ScheduleHsmClusterDeletionDetails

Details for scheduling HSM resource deletion.

ScheduleKeyDeletionDetails

Details for scheduling key deletion.

ScheduleKeyVersionDeletionDetails

Details for scheduling key version deletion.

ScheduleVaultDeletionDetails

Details for scheduling vault deletion.

SignDataDetails

The details of the message that you want to sign.

SignedData

The response to a request to sign the message.

UpdateEkmsPrivateEndpointDetails

Information needed to modify EKMS private endpoint resource

UpdateHsmClusterDetails

The details of the HsmCluster resource that you wish to update.

UpdateKeyDetails

The details of the Key that you wish to update.

UpdateVaultDetails

The details of the Vault that you wish to update.

UploadPartitionCertificatesDetails

An object that encapsulates the necessary partition certificates.

Vault

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

VaultReplicaDetails

Vault replica details

VaultReplicaSummary

Summary of vault replicas

VaultSummary

The details of the Vault.

VaultUsage

The details of the number of Keys and KeyVersions usage in a Vault.

VerifiedData

The response to a request to verify the message.

VerifyDataDetails

The details of the message that you want to verify.

WrappedImportKey

The details of the wrapped import Key.

WrappingKey

The public RSA wrapping key associated with the vault

Enums

AutoKeyRotationDetails.LastRotationStatusEnum

BackupLocation.DestinationEnum

CreateKeyDetails.ProtectionModeEnum

CreateVaultDetails.VaultTypeEnum

DecryptDataDetails.EncryptionAlgorithmEnum

DecryptedData.EncryptionAlgorithmEnum

EkmsPrivateEndpoint.LifecycleStateEnum

EkmsPrivateEndpointSummary.LifecycleStateEnum

EncryptDataDetails.EncryptionAlgorithmEnum

EncryptedData.EncryptionAlgorithmEnum

ExportKeyDetails.AlgorithmEnum

ExportedKeyData.AlgorithmEnum

HsmCluster.LifecycleStateEnum

HsmPartition.LifecycleStateEnum

ImportKeyDetails.ProtectionModeEnum

Key.LifecycleStateEnum

Key.ProtectionModeEnum

KeyShape.AlgorithmEnum

KeyShape.CurveIdEnum

KeySummary.AlgorithmEnum

KeySummary.LifecycleStateEnum

KeySummary.ProtectionModeEnum

KeyVersion.LifecycleStateEnum

KeyVersion.OriginEnum

KeyVersionSummary.LifecycleStateEnum

KeyVersionSummary.OriginEnum

PortInformation.PortTypeEnum

ReplicaDetails.StatusEnum

ReplicaVaultMetadata.VaultTypeEnum

SignDataDetails.MessageTypeEnum

SignDataDetails.SigningAlgorithmEnum

SignedData.SigningAlgorithmEnum

Vault.LifecycleStateEnum

Vault.VaultTypeEnum

VaultReplicaSummary.StatusEnum

VaultSummary.LifecycleStateEnum

VaultSummary.VaultTypeEnum

VerifyDataDetails.MessageTypeEnum

VerifyDataDetails.SigningAlgorithmEnum

WrappedImportKey.WrappingAlgorithmEnum

WrappingKey.LifecycleStateEnum

In this article
Back to top