Module: ActionController::HttpAuthentication::Token::ControllerMethods
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
::ActionController::Base ,
::ActionView::TestCase::TestController ,
Rails::ApplicationController,
::Rails::HealthController ,
Rails::InfoController,
Rails::MailersController,
Rails::WelcomeController
| |
Defined in: | actionpack/lib/action_controller/metal/http_authentication.rb |
Instance Method Summary
-
#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.
-
#authenticate_with_http_token(&login_procedure)
Authenticate using an HTTP Bearer token.
-
#request_http_token_authentication(realm = "Application", message = nil)
Render an HTTP header requesting the client to send a Bearer token for authentication.
Instance Method Details
#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
must not return a false value. Typically, the authenticated user is returned.
See ::ActionController::HttpAuthentication::Token
for example usage.
# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 432
def authenticate_or_request_with_http_token(realm = "Application", = nil, &login_procedure) authenticate_with_http_token(&login_procedure) || request_http_token_authentication(realm, ) 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.
# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 441
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.
# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 447
def request_http_token_authentication(realm = "Application", = nil) Token.authentication_request(self, realm, ) end