Class JwtAuthenticator

Authenticator using JSON Web Tokens (JWT). Uses SASL OAUTHBEARER for KV connections and Bearer token for HTTP requests.

Inheritance
object
BaseAuthenticator
JwtAuthenticator
Implements
Inherited Members
Namespace: Couchbase.Core.IO.Authentication.Authenticators
Assembly: Couchbase.NetClient.dll
Syntax
[InterfaceStability(Level.Uncommitted)]
public sealed class JwtAuthenticator : BaseAuthenticator, IAuthenticator

Constructors

| Edit this page View Source

JwtAuthenticator(string)

Creates a new JwtAuthenticator with the specified token.

Declaration
public JwtAuthenticator(string token)
Parameters
Type Name Description
string token

The JSON Web Token.

Fields

| Edit this page View Source

Token

Declaration
public readonly string Token
Field Value
Type Description
string

Properties

| Edit this page View Source

AuthenticatorType

Allows for easier type checking of authenticators without incurring the overhead of type checking against its concrete class.

Declaration
public override AuthenticatorType AuthenticatorType { get; }
Property Value
Type Description
AuthenticatorType
Overrides
| Edit this page View Source

CanReauthenticateKv

Determines whether this authenticator can be used to re-authenticate existing KV connections. E.g. JWT authenticator should re-authenticate existing KV connections when the token is refreshed, while the password and certificate authenticators leave existing connections untouched.

Declaration
public override bool CanReauthenticateKv { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

SupportsNonTls

Indicates whether this authenticator supports non-TLS connections.

Declaration
public override bool SupportsNonTls { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

SupportsTls

Indicates whether this authenticator supports TLS connections.

Declaration
public override bool SupportsTls { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

AuthenticateClientWebSocket(ClientWebSocket)

Takes a ClientWebSocket and applies authentication (e.g., setting headers).

Declaration
public override void AuthenticateClientWebSocket(ClientWebSocket clientWebSocket)
Parameters
Type Name Description
ClientWebSocket clientWebSocket

A ClientWebSocket object.
Overrides
| Edit this page View Source

AuthenticateHttpRequest(HttpRequestMessage)

Adds authentication to an HTTP request (e.g., Authorization header).

Declaration
public override void AuthenticateHttpRequest(HttpRequestMessage request)
Parameters
Type Name Description
HttpRequestMessage request

The HTTP request to authenticate.
Overrides

Implements