Uses of Package
com.oracle.bmc.keymanagement.model

Packages that use com.oracle.bmc.keymanagement.model

Package	Description
com.oracle.bmc.keymanagement
com.oracle.bmc.keymanagement.model
com.oracle.bmc.keymanagement.requests
com.oracle.bmc.keymanagement.responses

Classes in com.oracle.bmc.keymanagement.model used by com.oracle.bmc.keymanagement

Class and Description
EkmsPrivateEndpoint.LifecycleState The current state of the EKMS private endpoint resource.
EkmsPrivateEndpointSummary EKMS private endpoints summary Note: Objects should always be created or deserialized using the EkmsPrivateEndpointSummary.Builder.
HsmCluster.LifecycleState The HSMCluster’s current state.
HsmClusterSummary An object which encapsulates the details of a given HSM Cluster.
HsmPartition.LifecycleState A HSMCluster resource’s current lifecycle state.
HsmPartitionSummary An object which encapsulates the details of a given HSM.
Key.LifecycleState The key’s current lifecycle state.
KeySummary The details of the Key.
KeyVersion.LifecycleState The key version’s current lifecycle state.
KeyVersionSummary The details of the KeyVersion.
Vault The logical entity where the Vault service creates and durably stores keys.
Vault.LifecycleState The vault’s current lifecycle state.
VaultReplicaSummary Summary of vault replicas Note: Objects should always be created or deserialized using the VaultReplicaSummary.Builder.
VaultSummary The details of the Vault.
WrappingKey.LifecycleState The key’s current lifecycle state.

Classes in com.oracle.bmc.keymanagement.model used by com.oracle.bmc.keymanagement.model

Class and Description
AutoKeyRotationDetails The details of auto rotation schedule for the Key being create updated or imported.
AutoKeyRotationDetails.Builder
AutoKeyRotationDetails.LastRotationStatus The status of last execution of auto key rotation.
BackupKeyDetails The details of the Key that you wish to backup.
BackupKeyDetails.Builder
BackupLocation Backup upload location Note: Objects should always be created or deserialized using the Builder.
BackupLocation.Destination ‘Backup location destination: BUCKET - Uploading or downloading backup via object store bucket PRE_AUTHENTICATED_REQUEST_URI - Uploading or downloading backup via a PreAuthenticated object store URI’
BackupLocationBucket Object storage bucket details to upload or download the backup Note: Objects should always be created or deserialized using the BackupLocationBucket.Builder.
BackupLocationBucket.Builder
BackupLocationURI PreAuthenticated object storage URI to upload or download the backup Note: Objects should always be created or deserialized using the BackupLocationURI.Builder.
BackupLocationURI.Builder
BackupVaultDetails The details of the Vault that you wish to backup.
BackupVaultDetails.Builder
ChangeHsmClusterCompartmentDetails The details of the compartment you wish to move the hsm cluster to.
ChangeHsmClusterCompartmentDetails.Builder
ChangeKeyCompartmentDetails The deatils of the compartment that you wish to move the Key.
ChangeKeyCompartmentDetails.Builder
ChangeVaultCompartmentDetails The details of the compartment you wish to move the Vault.
ChangeVaultCompartmentDetails.Builder
CreateEkmsPrivateEndpointDetails Information needed to create EKMS private endpoint resource Note: Objects should always be created or deserialized using the CreateEkmsPrivateEndpointDetails.Builder.
CreateEkmsPrivateEndpointDetails.Builder
CreateHsmClusterDetails The details of the HSM cluster resource that you want to create.
CreateHsmClusterDetails.Builder
CreateKeyDetails The details of the key that you want to create.
CreateKeyDetails.Builder
CreateKeyDetails.ProtectionMode The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
CreateVaultDetails The details of the vault that you want to create.
CreateVaultDetails.Builder
CreateVaultDetails.VaultType The type of vault to create.
CreateVaultReplicaDetails Creates a vault replica.
CreateVaultReplicaDetails.Builder
DecryptDataDetails The details of the encrypted data that you want to decrypt.
DecryptDataDetails.Builder
DecryptDataDetails.EncryptionAlgorithm The encryption algorithm to use to encrypt or decrypt data with a customer-managed key.
DecryptedData The response to a request to decrypt the encrypted data.
DecryptedData.Builder
DecryptedData.EncryptionAlgorithm The encryption algorithm to use to encrypt and decrypt data with a customer-managed key AES_256_GCM indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).
DeleteVaultReplicaDetails Deletes a vault replica Note: Objects should always be created or deserialized using the DeleteVaultReplicaDetails.Builder.
DeleteVaultReplicaDetails.Builder
EkmsPrivateEndpoint EKMS private endpoint created in customer subnet used to connect to external key manager system Note: Objects should always be created or deserialized using the EkmsPrivateEndpoint.Builder.
EkmsPrivateEndpoint.Builder
EkmsPrivateEndpoint.LifecycleState The current state of the EKMS private endpoint resource.
EkmsPrivateEndpointSummary EKMS private endpoints summary Note: Objects should always be created or deserialized using the EkmsPrivateEndpointSummary.Builder.
EkmsPrivateEndpointSummary.Builder
EkmsPrivateEndpointSummary.LifecycleState The current state of the EKMS private endpoint resource.
EncryptDataDetails The details of the plaintext data that you want to encrypt.
EncryptDataDetails.Builder
EncryptDataDetails.EncryptionAlgorithm The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
EncryptedData The response to a request to encrypt the plaintext data.
EncryptedData.Builder
EncryptedData.EncryptionAlgorithm The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
ExportedKeyData The response to a request to export key material.
ExportedKeyData.Algorithm The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that persists on a hardware security module and, therefore, cannot be exported).
ExportedKeyData.Builder
ExportKeyDetails The details of the key that you want to wrap and export.
ExportKeyDetails.Algorithm The encryption algorithm to use to encrypt exportable key material from a software-backed key.
ExportKeyDetails.Builder
ExternalKeyManagerMetadata Metadata required for accessing External Key manager Note: Objects should always be created or deserialized using the ExternalKeyManagerMetadata.Builder.
ExternalKeyManagerMetadata.Builder
ExternalKeyManagerMetadataSummary Summary about metadata of external key manager to be returned to the customer as a response.
ExternalKeyManagerMetadataSummary.Builder
ExternalKeyReference A reference to the key on external key manager.
ExternalKeyReference.Builder
ExternalKeyReferenceDetails Key reference data to be returned to the customer as a response.
ExternalKeyReferenceDetails.Builder
ExternalKeyVersionReference A reference to key version on external key manager.
ExternalKeyVersionReference.Builder
GeneratedKey The reponse to the regeuest to generate the key to encrypt or decrypt the data.
GeneratedKey.Builder
GenerateKeyDetails The details of the key that you want to encrypt or decrypt data.
GenerateKeyDetails.Builder
HsmCluster Dedicated KMS-HSM Cluster Management Note: Objects should always be created or deserialized using the HsmCluster.Builder.
HsmCluster.Builder
HsmCluster.LifecycleState The HSMCluster’s current state.
HsmClusterCollection HsmClusterCollection object with page of HsmClusterSummary objects.
HsmClusterCollection.Builder
HsmClusterSummary An object which encapsulates the details of a given HSM Cluster.
HsmClusterSummary.Builder
HsmPartition Dedicated KMS-HSM Partition Management Note: Objects should always be created or deserialized using the HsmPartition.Builder.
HsmPartition.Builder
HsmPartition.LifecycleState A HSMCluster resource’s current lifecycle state.
HsmPartitionCollection HsmPartitionCollection object with page of HsmPartitionSummary objects.
HsmPartitionCollection.Builder
HsmPartitionSummary An object which encapsulates the details of a given HSM.
HsmPartitionSummary.Builder
ImportKeyDetails The details of the Key that you wish to import.
ImportKeyDetails.Builder
ImportKeyDetails.ProtectionMode The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
ImportKeyVersionDetails The details of the KeyVersion that you wish to import.
ImportKeyVersionDetails.Builder
Key The logical entities that represent one or more key versions, each of which contains cryptographic material.
Key.Builder
Key.LifecycleState The key’s current lifecycle state.
Key.ProtectionMode The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
KeyReplicaDetails Key replica details Note: Objects should always be created or deserialized using the KeyReplicaDetails.Builder.
KeyReplicaDetails.Builder
KeyShape The cryptographic properties of a key.
KeyShape.Algorithm The algorithm used by a key’s key versions to encrypt or decrypt.
KeyShape.Builder
KeyShape.CurveId Supported curve IDs for ECDSA keys.
KeySummary The details of the Key.
KeySummary.Algorithm The algorithm used by a key’s key versions to encrypt or decrypt data.
KeySummary.Builder
KeySummary.LifecycleState The key’s current lifecycle state.
KeySummary.ProtectionMode The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
KeyVersion The details of the KeyVersion associated with the Key.
KeyVersion.Builder
KeyVersion.LifecycleState The key version’s current lifecycle state.
KeyVersion.Origin The source of the key material.
KeyVersionReplicaDetails KeyVersion replica details Note: Objects should always be created or deserialized using the KeyVersionReplicaDetails.Builder.
KeyVersionReplicaDetails.Builder
KeyVersionSummary The details of the KeyVersion.
KeyVersionSummary.Builder
KeyVersionSummary.LifecycleState The key version’s current lifecycle state.
KeyVersionSummary.Origin The source of the key material.
OauthMetadata Authorization details required to get access token from IDP for accessing protected resources.
OauthMetadata.Builder
OauthMetadataSummary Summary about authorization to be returned to the customer as a response.
OauthMetadataSummary.Builder
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) Note: Objects should always be created or deserialized using the PortInformation.Builder.
PortInformation.Builder
PortInformation.PortType Port type associated for the port number.
PreCoUserCredentials Pre Crypto officer user credentials.
PreCoUserCredentials.Builder
ReplicaDetails Details of replication status Note: Objects should always be created or deserialized using the ReplicaDetails.Builder.
ReplicaDetails.Builder
ReplicaDetails.Status Replication status associated with a replicationId
ReplicationStatusDetails Details of replication status across all replica regions Note: Objects should always be created or deserialized using the ReplicationStatusDetails.Builder.
ReplicationStatusDetails.Builder
RestoreKeyFromObjectStoreDetails The details of the backup location from which you want to restore the Key.
RestoreKeyFromObjectStoreDetails.Builder
RestoreVaultFromObjectStoreDetails The details of the backup location from which you want to restore the Vault.
RestoreVaultFromObjectStoreDetails.Builder
ScheduleHsmClusterDeletionDetails Details for scheduling HSM resource deletion.
ScheduleHsmClusterDeletionDetails.Builder
ScheduleKeyDeletionDetails Details for scheduling key deletion.
ScheduleKeyDeletionDetails.Builder
ScheduleKeyVersionDeletionDetails Details for scheduling key version deletion.
ScheduleKeyVersionDeletionDetails.Builder
ScheduleVaultDeletionDetails Details for scheduling vault deletion.
ScheduleVaultDeletionDetails.Builder
SignDataDetails The details of the message that you want to sign.
SignDataDetails.Builder
SignDataDetails.MessageType Denotes whether the value of the message parameter is a raw message or a message digest.
SignDataDetails.SigningAlgorithm The algorithm to use to sign the message or message digest.
SignedData The response to a request to sign the message.
SignedData.Builder
SignedData.SigningAlgorithm The algorithm to use to sign the message or message digest.
UpdateEkmsPrivateEndpointDetails Information needed to modify EKMS private endpoint resource Note: Objects should always be created or deserialized using the UpdateEkmsPrivateEndpointDetails.Builder.
UpdateEkmsPrivateEndpointDetails.Builder
UpdateHsmClusterDetails The details of the HsmCluster resource that you wish to update.
UpdateHsmClusterDetails.Builder
UpdateKeyDetails The details of the Key that you wish to update.
UpdateKeyDetails.Builder
UpdateVaultDetails The details of the Vault that you wish to update.
UpdateVaultDetails.Builder
UploadPartitionCertificatesDetails An object that encapsulates the necessary partition certificates.
UploadPartitionCertificatesDetails.Builder
Vault The logical entity where the Vault service creates and durably stores keys.
Vault.Builder
Vault.LifecycleState The vault’s current lifecycle state.
Vault.VaultType The type of vault.
VaultReplicaDetails Vault replica details Note: Objects should always be created or deserialized using the VaultReplicaDetails.Builder.
VaultReplicaDetails.Builder
VaultReplicaSummary Summary of vault replicas Note: Objects should always be created or deserialized using the VaultReplicaSummary.Builder.
VaultReplicaSummary.Builder
VaultReplicaSummary.Status Status of the Vault
VaultSummary The details of the Vault.
VaultSummary.Builder
VaultSummary.LifecycleState A vault’s current lifecycle state.
VaultSummary.VaultType The type of vault.
VaultUsage The details of the number of Keys and KeyVersions usage in a Vault.
VaultUsage.Builder
VerifiedData The response to a request to verify the message.
VerifiedData.Builder
VerifyDataDetails The details of the message that you want to verify.
VerifyDataDetails.Builder
VerifyDataDetails.MessageType Denotes whether the value of the message parameter is a raw message or a message digest.
VerifyDataDetails.SigningAlgorithm The algorithm to use to sign the message or message digest.
WrappedImportKey The details of the wrapped import Key.
WrappedImportKey.Builder
WrappedImportKey.WrappingAlgorithm The wrapping mechanism to use during key import.
WrappingKey The public RSA wrapping key associated with the vault Note: Objects should always be created or deserialized using the WrappingKey.Builder.
WrappingKey.Builder
WrappingKey.LifecycleState The key’s current lifecycle state.

Classes in com.oracle.bmc.keymanagement.model used by com.oracle.bmc.keymanagement.requests

Class and Description
BackupKeyDetails The details of the Key that you wish to 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 Note: Objects should always be created or deserialized using the CreateEkmsPrivateEndpointDetails.Builder.
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.
DeleteVaultReplicaDetails Deletes a vault replica Note: Objects should always be created or deserialized using the DeleteVaultReplicaDetails.Builder.
EncryptDataDetails The details of the plaintext data that you want to encrypt.
ExportKeyDetails The details of the key that you want to wrap and export.
ExternalKeyVersionReference A reference to key version on external key manager.
GenerateKeyDetails The details of the key that you want to encrypt or decrypt data.
HsmPartition.LifecycleState A HSMCluster resource’s current lifecycle state.
ImportKeyDetails The details of the Key that you wish to import.
ImportKeyVersionDetails The details of the KeyVersion that you wish to import.
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.
UpdateEkmsPrivateEndpointDetails Information needed to modify EKMS private endpoint resource Note: Objects should always be created or deserialized using the UpdateEkmsPrivateEndpointDetails.Builder.
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.
VerifyDataDetails The details of the message that you want to verify.

Classes in com.oracle.bmc.keymanagement.model used by com.oracle.bmc.keymanagement.responses

Class and Description
DecryptedData The response to a request to decrypt the encrypted data.
EkmsPrivateEndpoint EKMS private endpoint created in customer subnet used to connect to external key manager system Note: Objects should always be created or deserialized using the EkmsPrivateEndpoint.Builder.
EkmsPrivateEndpointSummary EKMS private endpoints summary Note: Objects should always be created or deserialized using the EkmsPrivateEndpointSummary.Builder.
EncryptedData The response to a request to encrypt the plaintext data.
ExportedKeyData The response to a request to export key material.
GeneratedKey The reponse to the regeuest to generate the key to encrypt or decrypt the data.
HsmCluster Dedicated KMS-HSM Cluster Management Note: Objects should always be created or deserialized using the HsmCluster.Builder.
HsmClusterCollection HsmClusterCollection object with page of HsmClusterSummary objects.
HsmPartition Dedicated KMS-HSM Partition Management Note: Objects should always be created or deserialized using the HsmPartition.Builder.
HsmPartitionCollection HsmPartitionCollection object with page of HsmPartitionSummary objects.
Key The logical entities that represent one or more key versions, each of which contains cryptographic material.
KeySummary The details of the Key.
KeyVersion The details of the KeyVersion associated with the Key.
KeyVersionSummary The details of the KeyVersion.
PreCoUserCredentials Pre Crypto officer user credentials.
ReplicationStatusDetails Details of replication status across all replica regions Note: Objects should always be created or deserialized using the ReplicationStatusDetails.Builder.
SignedData The response to a request to sign the message.
Vault The logical entity where the Vault service creates and durably stores keys.
VaultReplicaSummary Summary of vault replicas Note: Objects should always be created or deserialized using the VaultReplicaSummary.Builder.
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.
WrappingKey The public RSA wrapping key associated with the vault Note: Objects should always be created or deserialized using the WrappingKey.Builder.