Object -
http
:
BasicAuthHandler
Defines the Basic Auth header handler for inbound and outbound HTTP traffic.
Constructor
__init
(InboundAuthProvider | OutboundAuthProvider authProvider)
- authProvider InboundAuthProvider | OutboundAuthProvider
-
The
auth:InboundAuthProvider
instance or theauth:OutboundAuthProvider
instance
Methods
Fields
- authProvider InboundAuthProvider | OutboundAuthProvider
-
The AuthProvider instance
Parameters
- req Request
-
The
http:Request
instance
-
Return Type
(boolean) true
if authentication is successful or elsefalse
Parameters
- req Request
-
The
http:Request
instance
-
Return Type
(boolean | AuthenticationError) true
if it is possible to authenticate with Basic Auth,false
otherwise, or else anhttp:AuthenticationError
in case of an error
Parameters
- req Request
-
The
http:Request
instance
-
Return Type
(Request | AuthenticationError) The updated
http:Request
instance or else anhttp:AuthenticationError
in case of an error
-
Return Type
(Request | AuthenticationError | ()) The updated
http:Request
instance or thehttp:AuthenticationError
in case of an error or else()
if nothing is to be returned