Interface IClusterAuthenticator

Namespace: Couchbase.Core.IO.Authentication.Authenticators

Assembly: Couchbase.NetClient.dll

Syntax

public interface IClusterAuthenticator

Methods

Authenticator(IAuthenticator)

Changes the instance of the IAuthenticator used by the cluster.

This method is meant to be used to update the JWT in use by the connections when it expires.

For rotating mTLS client certificates, use an implementation of IRotatingCertificateFactory directly when configuring your ClusterOptions.

Declaration

void Authenticator(IAuthenticator authenticator)

Parameters

Type	Name	Description
IAuthenticator	authenticator	The new IAuthenticator to use.

Remarks

Note: The type of IAuthenticator should not change at runtime. If you used Password authentication when creating the cluster, you should continue to use Password authentication when changing the authenticator.

For JwtAuthenticator: In addition to applying to new connections, the SDK will asynchronously re-authenticate all existing KV connections using the new JWT.