Skip to content

IAuthenticator

Represents an interface for various authentication implementations used in HTTP requests.

Methods:

Void SetupRequest(HTTPRequest)

Set required headers or content for the HTTP request. Called right before the request is sent out.
The SetupRequest method will be called every time the request is redirected or retried.

Boolean HandleChallange(HTTPRequest, HTTPResponse)

Called when the server is sending a 401 (Unauthorized) response with an WWW-Authenticate header. The authenticator might find additional knowledge about the authentication requirements (like what auth method it should use). If the authenticator is confident it can successfully (re)authenticate the request it can return true and the request will be resent to the server.

Comments