Method: FusionAuth::FusionAuthClient#login_ping

Defined in:

lib/fusionauth/fusionauth_client.rb

#login_ping(user_id, application_id, caller_ip_address) ⇒ FusionAuth::ClientResponse

Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth’s SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting.

Parameters:

• user_id (string) —

  The Id of the user that was logged in.

• application_id (string) —

  The Id of the application that they logged into.

• caller_ip_address (string) —

  (Optional) The IP address of the end-user that is logging in. If a null value is provided the IP address will be that of the client or last proxy that sent the request.

Returns:

• (FusionAuth::ClientResponse) —

  The ClientResponse object.

# File 'lib/fusionauth/fusionauth_client.rb', line 960

def login_ping(user_id, application_id, caller_ip_address)
  start.uri('/api/login')
      .url_segment(user_id)
      .url_segment(application_id)
      .url_parameter('ipAddress', caller_ip_address)
      .put()
      .go()
end