RestSharp

Authenticators

RestSharp includes authenticators for basic HTTP (Authorization header), NTLM and parameter-based systems.

Basic Authentication

The HttpBasicAuthenticator allows you pass a username and password as a basica auth Authorization header.

var client = new RestClient("http://example.com");
client.Authenticator = new HttpBasicAuthenticator("username", "password");
1
2

OAuth1

For OAuth1 authentication the OAuth1Authenticator class provides static methods to help generate an OAuth authenticator.

Request token

This method requires a consumerKey and consumerSecret to authenticate.

var client = new RestClient("http://example.com");
client.Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret);
1
2

Access token

This method retrieves an access token when provided consumerKey, consumerSecret, oauthToken, and oauthTokenSecret.

client.Authenticator = OAuth1Authenticator.ForAccessToken(
                        consumerKey, consumerSecret, oauthToken,
                        oauthTokenSecret
                       );
1
2
3
4

This method also includes an optional parameter to specity the OAuthSignatureMethod.

client.Authenticator = OAuth1Authenticator.ForAccessToken(consumerKey, 
                                                          consumerSecret, 
                                                          oauthToken, 
                                                          oauthTokenSecret, 
                                                          OAuthSignatureMethod.PlainText);
1
2
3
4
5

0-legged OAuth

The same access token authenticator can be used in 0-legged OAuth scenarios by providing null for the consumerSecret.

client.Authenticator = OAuth1Authenticator.ForAccessToken(consumerKey, null, oauthToken, oauthTokenSecret);
1

JWT

Custom Authenticator

You can write your own implementation by implementing IAuthenticator and registering it with your RestClient:

var client = new RestClient();
client.Authenticator = new SuperAuthenticator(); // implements IAuthenticator
1
2

The Authenticate method is the very first thing called upon calling RestClient.Execute or RestClient.Execute<T>. The Authenticate method is passed the RestRequest currently being executed giving you access to every part of the request data (headers, parameters, etc.)