instance method `http_basic_authenticate_with`

Ruby on Rails 8.0.4

Since v3.1.12

Available in: 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:

http_basic_authenticate_with(name:, password:, realm: nil, **options)

Enables HTTP Basic authentication.

See ActionController::HttpAuthentication::Basic for example usage.

Parameters

name keyreq
password keyreq
realm key = nil
options keyrest

Source

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 79
          def http_basic_authenticate_with(name:, password:, realm: nil, **options)
            raise ArgumentError, "Expected name: to be a String, got #{name.class}" unless name.is_a?(String)
            raise ArgumentError, "Expected password: to be a String, got #{password.class}" unless password.is_a?(String)
            before_action(options) { http_basic_authenticate_or_request_with name: name, password: password, realm: realm }
          end

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

Defined in ActionController::HttpAuthentication::Basic::ControllerMethods::ClassMethods

Signature

Parameters