Skip to content

Commit

Permalink
Merge pull request #49487 from yawboakye/clarify-login-procedure-expe…
Browse files Browse the repository at this point in the history
…ctation

Clarify `login_procedure`'s responsibility during request authentication
  • Loading branch information
rafaelfranca committed Oct 4, 2023
1 parent f05e283 commit 311f639
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,9 @@ module Token

module ControllerMethods
# Authenticate using an HTTP Bearer token, or otherwise render an HTTP
# header requesting the client to send a Bearer token.
# 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.
def authenticate_or_request_with_http_token(realm = "Application", message = nil, &login_procedure)
Expand Down

0 comments on commit 311f639

Please sign in to comment.