Class AuditEntry
Namespace: Cephalon.Abstractions.Audit
Assembly: Cephalon.Abstractions.dll
Describes one auditable operation recorded by the active audit implementation.
public sealed class AuditEntryInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”AuditEntry(string, string, string, string, string, string?, DateTimeOffset, AuditActor, AuditOutcome, string?, string?, IReadOnlyList<AuditChange>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)
Section titled “ AuditEntry(string, string, string, string, string, string?, DateTimeOffset, AuditActor, AuditOutcome, string?, string?, IReadOnlyList<AuditChange>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”Creates a new audit entry.
public AuditEntry(string id, string category, string action, string summary, string subjectType, string? subjectId, DateTimeOffset occurredAtUtc, AuditActor actor, AuditOutcome outcome = AuditOutcome.Unknown, string? tenantId = null, string? correlationId = null, IReadOnlyList<AuditChange>? changes = null, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable audit-entry identifier.
category string
The logical audit category such as identity, tenant, or billing.
action string
The logical action identifier associated with the audit event.
summary string
The human-readable audit summary.
subjectType string
The logical subject type associated with the entry.
subjectId string?
The stable subject identifier associated with the entry when one is known.
occurredAtUtc DateTimeOffset
The time at which the audited operation occurred.
actor AuditActor
The actor responsible for the audited operation.
outcome AuditOutcome
The outcome recorded for the audited operation.
tenantId string?
The tenant identifier associated with the audited operation.
correlationId string?
The correlation identifier associated with the audited operation.
changes IReadOnlyList<AuditChange>?
Optional field-level changes captured for the operation.
tags IReadOnlyList<string>?
Optional descriptive tags associated with the entry.
metadata IReadOnlyDictionary<string, string>?
Optional audit metadata.
Properties
Section titled “Properties”Action
Section titled “ Action”Gets the logical action identifier associated with the audit event.
public string Action { get; }Property Value
Section titled “Property Value”Gets the actor responsible for the audited operation.
public AuditActor Actor { get; }Property Value
Section titled “Property Value”Category
Section titled “ Category”Gets the logical audit category.
public string Category { get; }Property Value
Section titled “Property Value”Changes
Section titled “ Changes”Gets the field-level changes captured for the operation.
public IReadOnlyList<AuditChange> Changes { get; }Property Value
Section titled “Property Value”CorrelationId
Section titled “ CorrelationId”Gets the correlation identifier associated with the audited operation.
public string? CorrelationId { get; }Property Value
Section titled “Property Value”Gets the stable audit-entry identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets audit metadata associated with the entry.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
OccurredAtUtc
Section titled “ OccurredAtUtc”Gets the time at which the audited operation occurred.
public DateTimeOffset OccurredAtUtc { get; }Property Value
Section titled “Property Value”Outcome
Section titled “ Outcome”Gets the outcome recorded for the audited operation.
public AuditOutcome Outcome { get; }Property Value
Section titled “Property Value”SubjectId
Section titled “ SubjectId”Gets the stable subject identifier associated with the entry when one is known.
public string? SubjectId { get; }Property Value
Section titled “Property Value”SubjectType
Section titled “ SubjectType”Gets the logical subject type associated with the entry.
public string SubjectType { get; }Property Value
Section titled “Property Value”Summary
Section titled “ Summary”Gets the human-readable audit summary.
public string Summary { get; }Property Value
Section titled “Property Value”Gets descriptive tags associated with the entry.
public IReadOnlyList<string> Tags { get; }Property Value
Section titled “Property Value”TenantId
Section titled “ TenantId”Gets the tenant identifier associated with the audited operation.
public string? TenantId { get; }