instance method `authentication_request`

Ruby on Rails 5.2.8.1

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

authentication_request(controller, realm, message = nil)

Sets a WWW-Authenticate header to let the client know a token is desired.

controller - ActionController::Base instance for the outgoing response. realm - String realm to use in the header.

Returns nothing.

Parameters

controller req
realm req
message opt = nil

Source

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 512
      def authentication_request(controller, realm, message = nil)
        message ||= "HTTP Token: Access denied.\n"
        controller.headers["WWW-Authenticate"] = %(Token realm="#{realm.tr('"'.freeze, "".freeze)}")
        controller.__send__ :render, plain: message, status: :unauthorized
      end

Defined in actionpack/lib/action_controller/metal/http_authentication.rb line 512 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionController::HttpAuthentication::Token

Signature

Parameters