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.

put/api/login

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/login
  • Auth: API key in header Authorization

Headers

X-FusionAuth-TenantIdstring UUID

The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.

Request body

userIdstring uuid
applicationIdstring uuid
botDetectionScorenumber double
ipAddressstring
newDeviceboolean
noJWTboolean

Response

Success

changePasswordIdstring
changePasswordReason'Administrative' | 'Breached' | 'Expired' | 'Validation'
configurableMethodsstring[]
emailVerificationIdstring
identityVerificationIdstring
pendingIdPLinkIdstring
refreshTokenstring
refreshTokenIdstring uuid
registrationVerificationIdstring
stateobject
tokenstring
tokenExpirationInstantinteger

The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.

trustTokenstring
twoFactorIdstring
twoFactorTrustIdstring

Example response

{
  "user": {
    "preferredLanguages": [
      "en_US"
    ],
    "birthDate": "2007-12-03",
    "timezone": "America/Denver",
    "registrations": [
      {
        "preferredLanguages": [
          "en_US"
        ],
        "timezone": "America/Denver"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.