authentication.md

layout	title	permalink	hide	next_name	next_link	top_name	top_link
documentation	Authentication Middleware	/middleware/authentication	true	Multipart Middleware	./multipart	Back to Middleware	./list

The Faraday::Request::Authorization middleware allows you to automatically add an Authorization header to your requests. It also features 2 specialised sub-classes that provide useful extra features for Basic Authentication and Token Authentication requests.

Any Authentication

The generic Authorization middleware allows you to add any type of Authorization header.

Faraday.new(...) do |conn|
  conn.request :authorization, 'Bearer', 'authentication-token'
end

With a proc

You can also provide a proc, which will be evaluated on each request:

Faraday.new(...) do |conn|
 conn.request :authorization, 'Bearer', -> { MyAuthStorage.get_auth_token }
end

Basic Authentication

BasicAuthentication adds a 'Basic' type Authorization header to a Faraday request.

Faraday.new(...) do |conn|
  conn.request :basic_auth, 'username', 'password'
end

Token Authentication

TokenAuthentication adds a 'Token' type Authorization header to a Faraday request. You can optionally provide a hash of options that will be appended to the token. This is not used anymore in modern web and have been replaced by Bearer tokens.

Faraday.new(...) do |conn|
  conn.request :token_auth, 'authentication-token', **options
end