Skip to Content Skip to Search

module ActionController::HttpAuthentication::Token::ControllerMethods

Public instance methods

authenticate_or_request_with_http_token(realm = "Application", message = nil, &login_procedure)

Authenticate using an HTTP Bearer token, or otherwise render an HTTP header requesting the client to send a Bearer token. For the authentication to be considered successful, login_procedure should return a non-nil value. Typically, the authenticated user is returned.

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

Source code GitHub 
# File actionpack/lib/action_controller/metal/http_authentication.rb, line 438
def authenticate_or_request_with_http_token(realm = "Application", message = nil, &login_procedure)
  authenticate_with_http_token(&login_procedure) || request_http_token_authentication(realm, message)
end

authenticate_with_http_token(&login_procedure)

Authenticate using an HTTP Bearer token. Returns the return value of login_procedure if a token is found. Returns nil if no token is found.

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

Source code GitHub 
# File actionpack/lib/action_controller/metal/http_authentication.rb, line 446
def authenticate_with_http_token(&login_procedure)
  Token.authenticate(self, &login_procedure)
end

request_http_token_authentication(realm = "Application", message = nil)

Render an HTTP header requesting the client to send a Bearer token for authentication.

Source code GitHub 
# File actionpack/lib/action_controller/metal/http_authentication.rb, line 452
def request_http_token_authentication(realm = "Application", message = nil)
  Token.authentication_request(self, realm, message)
end

Definition files