Object -
http
:
BearerAuthHandler
Representation of the Bearer Auth header handler for both inbound and outbound HTTP traffic.
Constructor
__init
(InboundAuthProvider | OutboundAuthProvider authProvider)
- authProvider InboundAuthProvider | OutboundAuthProvider
-
The
auth:InboundAuthProvider
instance or theauth:OutboundAuthProvider
instance
Methods
Checks if the request can be authenticated with the Bearer Auth header.
Authenticates the incoming request with the use of credentials passed as the Bearer Auth header.
Prepares the request with the Bearer Auth header.
Inspects the request and response and calls the Auth provider for inspection.
Fields
- authProvider InboundAuthProvider | OutboundAuthProvider
-
The
InboundAuthProvider
instance or theOutboundAuthProvider
instance
Checks if the request can be authenticated with the Bearer Auth header.
Parameters
- req Request
-
The
http:Request
instance
-
Return Type
(boolean) true
if it can be authenticated or elsefalse
Authenticates the incoming request with the use of credentials passed as the Bearer Auth header.
Parameters
- req Request
-
The
http:Request
instance
-
Return Type
(boolean | AuthenticationError) true
if authenticated successfully,false
otherwise, or else anhttp:AuthenticationError
in case of an error
Prepares the request with the Bearer Auth header.
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
Inspects the request and response and calls the Auth provider for inspection.
-
Return Type
(Request | AuthenticationError | ()) The updated
http:Request
instance, anhttp:AuthenticationError
in case of an error, or else()
if nothing is to be returned