instance method
authentication_request
Ruby on Rails edge
Since v3.0.20Signature
authentication_request(controller, realm, message = nil, content_type = nil, scheme: nil)Sets a WWW-Authenticate header to let the client know a token is desired.
Returns nothing.
Parameters
-
controller-ActionController::Baseinstance for the outgoing response. -
realm- String realm to use in the header. -
scheme- Optional authentication scheme (or array of schemes) to use in the header, verbatim. Multiple schemes are emitted as separate challenges. Defaults to"Token".
Parameters
-
controllerreq -
realmreq -
messageopt = nil -
content_typeopt = nil -
schemekey = nil
Source
# File actionpack/lib/action_controller/metal/http_authentication.rb, line 577
def authentication_request(controller, realm, message = nil, content_type = nil, scheme: nil)
schemes = Array(scheme).presence || ["Token"]
message ||= "HTTP Token: Access denied.\n"
challenges = schemes.map { |s| %(#{s} realm="#{realm.tr('"', "")}") }
controller.headers["WWW-Authenticate"] = challenges.join(", ")
controller.__send__ :render, plain: message, status: :unauthorized, content_type: content_type
end
Defined in actionpack/lib/action_controller/metal/http_authentication.rb line 577
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActionController::HttpAuthentication::Token