SecretInventoryItem
Namespace: Meshmakers.Octo.Runtime.Contracts.Secrets
One Secret slot of an entity. Never carries a value.
public record SecretInventoryItem : IEquatable<SecretInventoryItem>
Inheritance Object → SecretInventoryItem
Implements IEquatable<SecretInventoryItem>
Properties
CkTypeId
CK type of the entity (runtime id)
public string CkTypeId { get; set; }
Property Value
RtId
Runtime id of the entity
public OctoObjectId RtId { get; set; }
Property Value
OctoObjectId
RtWellKnownName
Well-known name of the entity, if any
public string RtWellKnownName { get; set; }
Property Value
DisplayName
Display name of the entity: the stored display name, else a string Name attribute of the type,
else the well-known name; null otherwise (show the rtId)
public string DisplayName { get; set; }
Property Value
AttributePath
camelCase path of the slot: password; record members endpoints[key=prod].token (record array,
element addressed by its record key; endpoints[0].token when the record declares no key) and
credentials.token (single record)
public string AttributePath { get; set; }
Property Value
AttributeName
CK attribute name (PascalCase) of the top-level attribute
public string AttributeName { get; set; }
Property Value
Required
True when the slot's attribute is required (for a record member: within its record)
public bool Required { get; set; }
Property Value
Form
Storage form
public SecretStorageForm Form { get; set; }
Property Value
KeyId
Key id (SecretStorageForm.EncV2 / SecretStorageForm.KeyMissing only)
public string KeyId { get; set; }
Property Value
SetAt
"Set at" (UTC) of a protected value; null for legacy / not set / unknown
public Nullable<DateTime> SetAt { get; set; }
Property Value
NeedsReEntry
SecretStorageForm.KeyMissing or SecretStorageForm.Corrupt, or
SecretStorageForm.NotSet and Required
public bool NeedsReEntry { get; set; }
Property Value
Constructors
SecretInventoryItem(String, OctoObjectId, String, String, String, String, Boolean, SecretStorageForm, String, Nullable<DateTime>, Boolean)
One Secret slot of an entity. Never carries a value.
public SecretInventoryItem(string CkTypeId, OctoObjectId RtId, string RtWellKnownName, string DisplayName, string AttributePath, string AttributeName, bool Required, SecretStorageForm Form, string KeyId, Nullable<DateTime> SetAt, bool NeedsReEntry)
Parameters
CkTypeId String
CK type of the entity (runtime id)
RtId OctoObjectId
Runtime id of the entity
RtWellKnownName String
Well-known name of the entity, if any
DisplayName String
Display name of the entity: the stored display name, else a string Name attribute of the type,
else the well-known name; null otherwise (show the rtId)
AttributePath String
camelCase path of the slot: password; record members endpoints[key=prod].token (record array,
element addressed by its record key; endpoints[0].token when the record declares no key) and
credentials.token (single record)
AttributeName String
CK attribute name (PascalCase) of the top-level attribute
Required Boolean
True when the slot's attribute is required (for a record member: within its record)
Form SecretStorageForm
Storage form
KeyId String
Key id (SecretStorageForm.EncV2 / SecretStorageForm.KeyMissing only)
SetAt Nullable<DateTime>
"Set at" (UTC) of a protected value; null for legacy / not set / unknown
NeedsReEntry Boolean
SecretStorageForm.KeyMissing or SecretStorageForm.Corrupt, or
SecretStorageForm.NotSet and Required
Methods
IsReEntryNeeded(SecretStorageForm, Boolean)
The re-entry rule of SecretInventoryItem.NeedsReEntry.
public static bool IsReEntryNeeded(SecretStorageForm form, bool required)
Parameters
form SecretStorageForm
required Boolean