Table of Contents

Class AuthenticationOptions

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

Configures authentication methods and credential management for Elasticsearch connections.

public sealed class AuthenticationOptions
Inheritance
AuthenticationOptions
Inherited Members

Properties

ApiKeyId

Gets the API key identifier for API key authentication.

public string? ApiKeyId { get; init; }

Property Value

string

The API key ID for Elasticsearch API key authentication, or null if not used.

Base64ApiKey

Gets the Base64-encoded API key for legacy authentication scenarios.

public string? Base64ApiKey { get; init; }

Property Value

string

The complete Base64-encoded API key, or null if not used.

CredentialRotation

Gets the credential rotation configuration.

public CredentialRotationOptions CredentialRotation { get; init; }

Property Value

CredentialRotationOptions

Settings for automatic credential rotation and lifecycle management.

OAuth2

Gets the OAuth2 authentication configuration.

public OAuth2Options OAuth2 { get; init; }

Property Value

OAuth2Options

Settings for OAuth2/OpenID Connect authentication.

ServiceAccount

Gets the service account authentication configuration.

public ServiceAccountOptions ServiceAccount { get; init; }

Property Value

ServiceAccountOptions

Settings for service account-based authentication.

Username

Gets the username for basic authentication.

public string? Username { get; init; }

Property Value

string

The username for HTTP basic authentication, or null if not used.