Object - http : BasicAuthHandler

Defines the Basic Auth header handler for inbound and outbound HTTP traffic.

Constructor

__init

(InboundAuthProvider | OutboundAuthProvider authProvider)

Methods

Fields

canProcess

(Request req)

returns boolean

Checks if the provided request can be authenticated with the Basic Auth header.

Parameters

  • Return Type

    (boolean)
  • Returns true if authentication is successful. Else, returns false

process

(Request req)

returns boolean | AuthenticationError

Authenticates the incoming request with the use of the credentials passed as the Basic Auth header.

Parameters

  • Return Type

    (boolean | AuthenticationError)
  • Returns true if it is possible to authenticate with Basic Auth. Else, returns false or the AuthenticationError in case of an error

prepare

(Request req)

returns Request | AuthenticationError

Prepares the request with the Basic Auth header.

Parameters

inspect

(Request req, Response resp)

returns Request | AuthenticationError | ()

Inspects the request and response and calls the Auth provider for inspection.

Parameters

  • Return Type

    (Request | AuthenticationError | ())
  • Returns the updated Request instance, the AuthenticationError in case of an error, or () if nothing is to be returned