Class SecretSummary

The details of the secret, excluding the contents of the secret.

Inheritance

object

SecretSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.VaultService.Models

Assembly: OCI.DotNetSDK.Vault.dll

Syntax

public class SecretSummary

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 the secret.

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"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A brief description of the secret.

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 secret.

Remarks

Required

IsAutoGenerationEnabled

Declaration

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

Property Value

Type	Description
bool?	The value of this flag determines whether or not secret content will be generated automatically.

IsReplica

Declaration

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

Property Value

Type	Description
bool?	A Boolean value that indicates whether the secret is a source or replica secret.

KeyId

Declaration

[JsonProperty(PropertyName = "keyId")]
public string KeyId { get; set; }

Property Value

Type	Description
string	The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

LastRotationTime

Declaration

[JsonProperty(PropertyName = "lastRotationTime")]
public DateTime? LastRotationTime { get; set; }

Property Value

Type	Description
DateTime?	A property indicating when the secret was last rotated successfully, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the secret's current lifecycle state.

LifecycleState

Declaration

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

Property Value

Type	Description
SecretSummary.LifecycleStateEnum?	The current lifecycle state of the secret.

Remarks

Required

NextRotationTime

Declaration

[JsonProperty(PropertyName = "nextRotationTime")]
public DateTime? NextRotationTime { get; set; }

Property Value

Type	Description
DateTime?	A property indicating when the secret is scheduled to be rotated, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

ReplicationConfig

Declaration

[JsonProperty(PropertyName = "replicationConfig")]
public ReplicationConfig ReplicationConfig { get; set; }

Property Value

Type	Description
ReplicationConfig

RotationConfig

Declaration

[JsonProperty(PropertyName = "rotationConfig")]
public RotationConfig RotationConfig { get; set; }

Property Value

Type	Description
RotationConfig

RotationStatus

Declaration

[JsonProperty(PropertyName = "rotationStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Secret.RotationStatusEnum? RotationStatus { get; set; }

Property Value

Type	Description
Secret.RotationStatusEnum?	Additional information about the status of the secret rotation

SecretGenerationContext

Declaration

[JsonProperty(PropertyName = "secretGenerationContext")]
public SecretGenerationContext SecretGenerationContext { get; set; }

Property Value

Type	Description
SecretGenerationContext

SecretName

Declaration

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

Property Value

Type	Description
string	The name of the secret.

Remarks

Required

SourceRegionInformation

Declaration

[JsonProperty(PropertyName = "sourceRegionInformation")]
public SourceRegionInformation SourceRegionInformation { get; set; }

Property Value

Type	Description
SourceRegionInformation

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	A property indicating when the secret was created, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Remarks

Required

TimeOfCurrentVersionExpiry

Declaration

[JsonProperty(PropertyName = "timeOfCurrentVersionExpiry")]
public DateTime? TimeOfCurrentVersionExpiry { get; set; }

Property Value

Type	Description
DateTime?	An optional property indicating when the current secret version will expire, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

TimeOfDeletion

Declaration

[JsonProperty(PropertyName = "timeOfDeletion")]
public DateTime? TimeOfDeletion { get; set; }

Property Value

Type	Description
DateTime?	An optional property indicating when to delete the secret, 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 in which the secret exists

Remarks

Required