Class Secret

The details of the secret. Secret details do not contain the contents of the secret itself.

Inheritance

object

Secret

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 Secret

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 where you want to create the secret.

Remarks

Required

CurrentVersionNumber

Declaration

[JsonProperty(PropertyName = "currentVersionNumber")]
public long? CurrentVersionNumber { get; set; }

Property Value

Type	Description
long?	The version number of the secret version that's currently in use.

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. Avoid entering confidential information.

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.

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 current lifecycle state of the secret.

LifecycleState

Declaration

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

Property Value

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

Remarks

Required

Metadata

Declaration

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

Property Value

Type	Description
Dictionary<string, object>	Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

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

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 user-friendly name of the secret. Avoid entering confidential information.

Remarks

Required

SecretRules

Declaration

[JsonProperty(PropertyName = "secretRules")]
public List<SecretRule> SecretRules { get; set; }

Property Value

Type	Description
List<SecretRule>	A list of rules that control how the secret is used and managed.

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

Remarks

Required