Class KeyVersion

The details of the KeyVersion associated with the Key.

Inheritance
object
KeyVersion
Inherited Members
Namespace: Oci.KeymanagementService.Models
Assembly: OCI.DotNetSDK.Keymanagement.dll
Syntax
public class KeyVersion

Properties

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 this key version.
Remarks

Required

ExternalKeyReferenceDetails

Declaration
[JsonProperty(PropertyName = "externalKeyReferenceDetails")]
public ExternalKeyReferenceDetails ExternalKeyReferenceDetails { get; set; }
Property Value
Type Description
ExternalKeyReferenceDetails

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 version.
Remarks

Required

IsAutoRotated

Declaration
[JsonProperty(PropertyName = "isAutoRotated")]
public bool? IsAutoRotated { get; set; }
Property Value
Type Description
bool?

A Boolean Value indicating whether this keyversion is generated from auto rotation of key

IsPrimary

Declaration
[JsonProperty(PropertyName = "isPrimary")]
public bool? IsPrimary { get; set; }
Property Value
Type Description
bool?

A Boolean value that indicates whether the KeyVersion belongs to primary Vault or replica Vault.

KeyId

Declaration
[Required(ErrorMessage = "KeyId is required.")]
[JsonProperty(PropertyName = "keyId")]
public string KeyId { get; set; }
Property Value
Type Description
string

The OCID of the key associated with this key version.
Remarks

Required

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeyVersion.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
KeyVersion.LifecycleStateEnum?

The key version's current lifecycle state.
Example: ENABLED

Origin

Declaration
[JsonProperty(PropertyName = "origin")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeyVersion.OriginEnum? Origin { get; set; }
Property Value
Type Description
KeyVersion.OriginEnum?

The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source.

PublicKey

Declaration
[JsonProperty(PropertyName = "publicKey")]
public string PublicKey { get; set; }
Property Value
Type Description
string

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

ReplicaDetails

Declaration
[JsonProperty(PropertyName = "replicaDetails")]
public KeyVersionReplicaDetails ReplicaDetails { get; set; }
Property Value
Type Description
KeyVersionReplicaDetails

RestoredFromKeyVersionId

Declaration
[JsonProperty(PropertyName = "restoredFromKeyVersionId")]
public string RestoredFromKeyVersionId { get; set; }
Property Value
Type Description
string

The OCID of the key version from which this key version was restored.

TimeCreated

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

The date and time this key version was created, expressed in RFC 3339 timestamp format.
Example: "2018-04-03T21:10:29.600Z"
Remarks

Required

TimeOfDeletion

Declaration
[JsonProperty(PropertyName = "timeOfDeletion")]
public DateTime? TimeOfDeletion { get; set; }
Property Value
Type Description
DateTime?

An optional property indicating when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

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 this key version.
Remarks

Required