Class CouchdbSessionAuthenticator

The CouchdbSessionAuthenticator is used to get CouchDB session authentication information to requests.

CouchDB Session Authenticator stores Authentication data in a Cookie Jar and that will be used during a request. The following token information are stored in the CookieJar.

Cookie-Content: AuthSession=<sessionToken>; Expires=<expirationDate>; Max-Age=<refreshmentTimeInSeconds>
                Version=1; Path=/; HttpOnly; Secure

Hierarchy

  • Authenticator
    • CouchdbSessionAuthenticator

Constructors

constructor

Properties

requiredOptions tokenManager tokenOptions AUTHTYPE_COUCHDB_SESSION

Methods

authenticate authenticationType configure

Constructors

constructor

Properties

Protected requiredOptions

requiredOptions: ["username", "password"]

Protected tokenManager

tokenManager: SessionTokenManager

Private tokenOptions

tokenOptions: SessionTokenManagerOptions

Static Readonly AUTHTYPE_COUCHDB_SESSION

AUTHTYPE_COUCHDB_SESSION: "COUCHDB_SESSION" = 'COUCHDB_SESSION'

Methods

authenticate

  • Acquire a session token that will be stored in a Cookie Jar. The same jar will be in use in the request.

    Parameters

    • requestOptions: object

      The request to augment with authentication information.

    Returns Promise<void>

authenticationType

  • Returns the authenticator's type ('COUCHDB_SESSION').

    Returns

    a string that indicates the authenticator's type

    Returns string

configure

  • Configure the TokenManager to use all the request settings together with the basic credentials.

    Parameters

    • userOptions: UserOptions

      Configuration values for a request service.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc