Module: ActionController::HttpAuthentication::Token::ControllerMethods

Defined in:
actionpack/lib/action_controller/metal/http_authentication.rb

Instance Method Summary collapse

Instance Method Details

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

Authenticate using an HTTP Bearer token, or otherwise render an HTTP header requesting the client to send a Bearer token.

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


430
431
432
# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 430

def authenticate_or_request_with_http_token(realm = "Application", message = nil, &)
  authenticate_with_http_token(&) || request_http_token_authentication(realm, message)
end

#authenticate_with_http_token(&login_procedure) ⇒ Object

Authenticate using an HTTP Bearer token. Returns true if authentication is successful, false otherwise.


436
437
438
# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 436

def authenticate_with_http_token(&)
  Token.authenticate(self, &)
end

#request_http_token_authentication(realm = "Application", message = nil) ⇒ Object

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


442
443
444
# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 442

def request_http_token_authentication(realm = "Application", message = nil)
  Token.authentication_request(self, realm, message)
end