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:InboundAuthProviderinstance or theauth:OutboundAuthProviderinstance
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
InboundAuthProviderinstance or theOutboundAuthProviderinstance
Checks if the request can be authenticated with the Bearer Auth header.
Parameters
- req Request
-
The
http:Requestinstance
-
Return Type
(boolean) trueif 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:Requestinstance
-
Return Type
(boolean | AuthenticationError) trueif authenticated successfully,falseotherwise, or else anhttp:AuthenticationErrorin case of an error
Prepares the request with the Bearer Auth header.
Parameters
- req Request
-
The
http:Requestinstance
-
Return Type
(Request | AuthenticationError) The updated
http:Requestinstance or else anhttp:AuthenticationErrorin case of an error
Inspects the request and response and calls the Auth provider for inspection.
-
Return Type
(Request | AuthenticationError | ()) The updated
http:Requestinstance, anhttp:AuthenticationErrorin case of an error, or else()if nothing is to be returned