Class KeySummary

The details of the Key.

Inheritance

object

KeySummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.KeymanagementService.Models

Assembly: OCI.DotNetSDK.Keymanagement.dll

Syntax

public class KeySummary

Properties

Algorithm

Declaration

[JsonProperty(PropertyName = "algorithm")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeySummary.AlgorithmEnum? Algorithm { get; set; }

Property Value

Type	Description
KeySummary.AlgorithmEnum?	The algorithm used by a key's key versions to encrypt or decrypt data.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the key.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, 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

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

Remarks

Required

ExternalKeyReferenceDetails

Declaration

[JsonProperty(PropertyName = "externalKeyReferenceDetails")]
public ExternalKeyReferenceDetails ExternalKeyReferenceDetails { get; set; }

Property Value

Type	Description
ExternalKeyReferenceDetails

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the key.

Remarks

Required

IsAutoRotationEnabled

Declaration

[JsonProperty(PropertyName = "isAutoRotationEnabled")]
public bool? IsAutoRotationEnabled { get; set; }

Property Value

Type	Description
bool?	A parameter specifying whether the auto key rotation is enabled or not.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeySummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
KeySummary.LifecycleStateEnum?	The key's current lifecycle state. Example: ENABLED

Remarks

Required

ProtectionMode

Declaration

[JsonProperty(PropertyName = "protectionMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeySummary.ProtectionModeEnum? ProtectionMode { get; set; }

Property Value

Type Description

Type	Description
KeySummary.ProtectionModeEnum?	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. A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.

KeySummary.ProtectionModeEnum?

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. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Remarks

Required

VaultId

Declaration

[Required(ErrorMessage = "VaultId is required.")]
[JsonProperty(PropertyName = "vaultId")]
public string VaultId { get; set; }

Property Value

Type	Description
string	The OCID of the vault that contains the key.

Remarks

Required