Object - http : InboundAuthHandler

The representation of an inbound authentication handler for HTTP traffic.

Methods

Checks if the request can be authenticated with the relevant InboundAuthHandler implementation.

Tries to authenticate the request with the relevant InboundAuthHandler implementation.

canProcess

(Request req)

returns boolean

Checks if the request can be authenticated with the relevant InboundAuthHandler implementation.

Parameters

  • req Request
  • The http:Request instance

  • Return Type

    (boolean)
  • true if it can be authenticated or else false

process

(Request req)

returns boolean | AuthenticationError

Tries to authenticate the request with the relevant InboundAuthHandler implementation.

Parameters

  • req Request
  • The http:Request instance

  • Return Type

    (boolean | AuthenticationError)
  • true if it authenticated successfully, false otherwise, or else an http:AuthenticationError in case of errors