Class ApiKeyAuthenticationCredentials

Credentials for Api Key Authentication

Inheritance

object

ApiKeyAuthenticationCredentials

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class ApiKeyAuthenticationCredentials : IDisposable

Constructors

ApiKeyAuthenticationCredentials()

Declaration

public ApiKeyAuthenticationCredentials()

ApiKeyAuthenticationCredentials(SecureString)

Declaration

public ApiKeyAuthenticationCredentials(SecureString base64EncodedApiKey)

Parameters

Type	Name	Description
SecureString	base64EncodedApiKey

ApiKeyAuthenticationCredentials(string)

Declaration

public ApiKeyAuthenticationCredentials(string base64EncodedApiKey)

Parameters

Type	Name	Description
string	base64EncodedApiKey

ApiKeyAuthenticationCredentials(string, SecureString)

Declaration

public ApiKeyAuthenticationCredentials(string id, SecureString apiKey)

Parameters

Type	Name	Description
string	id
SecureString	apiKey

ApiKeyAuthenticationCredentials(string, string)

Declaration

public ApiKeyAuthenticationCredentials(string id, string apiKey)

Parameters

Type	Name	Description
string	id
string	apiKey

Properties

Base64EncodedApiKey

The Base64 encoded api key with which to authenticate Take the form, id:api_key, which is then base 64 encoded

Declaration

public SecureString Base64EncodedApiKey { get; }

Property Value

Type	Description
SecureString

Methods

Dispose()

Declaration

public void Dispose()

Implements

IDisposable

Extension Methods

SuffixExtensions.Suffix(object, string)