Table of Contents

Class SecretMetadata

Namespace
Excalibur.Data.ElasticSearch.Security
Assembly
Excalibur.Data.ElasticSearch.dll

Contains metadata information about a stored secret.

public sealed class SecretMetadata
Inheritance
SecretMetadata
Inherited Members

Remarks

Initializes a new instance of the SecretMetadata class.

Constructors

SecretMetadata(string?, DateTimeOffset?, IReadOnlyDictionary<string, string>?, SecretRotationPolicy?)

Contains metadata information about a stored secret.

public SecretMetadata(string? description = null, DateTimeOffset? expiresAt = null, IReadOnlyDictionary<string, string>? tags = null, SecretRotationPolicy? rotationPolicy = null)

Parameters

description string

A description of the secret's purpose.

expiresAt DateTimeOffset?

The expiration time for the secret.

tags IReadOnlyDictionary<string, string>

Optional tags for categorizing the secret.

rotationPolicy SecretRotationPolicy

The rotation policy for the secret.

Remarks

Initializes a new instance of the SecretMetadata class.

Properties

CreatedAt

Gets the timestamp when the secret was created.

public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

The UTC timestamp of secret creation.

Description

Gets the description of the secret's purpose.

public string? Description { get; }

Property Value

string

A human-readable description of what the secret is used for.

ExpiresAt

Gets the expiration time for the secret.

public DateTimeOffset? ExpiresAt { get; }

Property Value

DateTimeOffset?

The UTC timestamp when the secret expires, or null if it doesn't expire.

LastModifiedAt

Gets the timestamp when the secret was last modified.

public DateTimeOffset LastModifiedAt { get; }

Property Value

DateTimeOffset

The UTC timestamp of the last secret modification.

RotationPolicy

Gets the rotation policy for the secret.

public SecretRotationPolicy? RotationPolicy { get; }

Property Value

SecretRotationPolicy

The policy defining how and when the secret should be rotated.

Tags

Gets the tags associated with the secret for categorization.

public IReadOnlyDictionary<string, string> Tags { get; }

Property Value

IReadOnlyDictionary<string, string>

A read-only dictionary of key-value pairs for secret categorization.

Version

Gets the version of the secret metadata.

public string Version { get; }

Property Value

string

The version identifier for tracking metadata changes.