Get login log | GenAuth Docs

Update time: 2025-07-23 07:34:21

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Get login log

¶ Method name

AuthenticationClient.get_login_history

¶ Request parameters

Name	Type	Required	Default value	Description	Sample value
appId	string	No	-	Application ID, can be filtered by application ID. By default, it is not passed to get the login history of all applications.	`5f6265c67fxxxxae64ec516e`
clientIp	string	No	-	Client IP, can be filtered by the client IP at the time of login. By default, it is not passed to get the login history of all login IPs.	`127.0.0.1`
success	boolean	no	-	Whether the login is successful or not. You can filter based on whether the login is successful or not. By default, the acquired records contain both successful and failed login histories.	`true`
start	number	No	-	Start time, as a timestamp in milliseconds	`1660828100000`
end	number	No	-	End time, as a timestamp in milliseconds	`1660828100000`
page	number	No	1	Current page number, starting from 1	`1`
limit	number	No	10	Number of pages per page, maximum cannot exceed 50, default is 10	`10`

¶ Request response

Type: GetLoginHistoryRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful, 200 means success.
message	string	description
apiCode	number	Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	LoginHistoryPaginatedRespDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "userId": "xxx",
      "appId": "xxx",
      "appName": "Sample application",
      "appLoginUrl": "https://example.genauth.ai/login",
      "appLogo": "https://files.authing.co/authing-console/default-app-logo.png",
      "loginAt": "2022-07-03T02:20:30.000Z",
      "clientIp": "127.0.0.1",
      "success": true,
      "errorMessage": "The account or password is incorrect",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
      "parsedUserAgent": {
        "device": "Desktop",
        "browser": "Chrome",
        "os": "Windows"
      },
      "loginMethod": "loginByEmail",
      "geoip": {
        "location": { "lon": 116.3889, "lat": 39.9288 },
        "country_name": "China",
        "country_code2": "CN",
        "country_code3": "CN",
        "region_name": "Beijing",
        "region_code": "BJ",
        "city_name": "Beijing",
        "continent_code": "AS",
        "timezone": "Asia/Shanghai"
      },
      "tenantId": "642c1df417c2d8a80d744c1d"
    }
  }
}

¶ Data structure

¶ LoginHistoryPaginatedRespDto

Name	Type	Is it required?	Description	Sample value
totalCount	number	Yes	Total number of records
list	array	Yes	List of records Nested type: LoginHistoryDto.

¶ LoginHistoryDto

Name	Type	Is it required?	Description	Sample value
userId	string	Yes	User ID	`xxx`
appId	string	Yes	Application ID	`xxx`
appName	string	Yes	Application name	`Sample application`
appLoginUrl	string	Yes	Application login address	`https://example.genauth.ai/login`
appLogo	string	Yes	Application Logo	`https://files.authing.co/authing-console/default-app-logo.png`
loginAt	string	Yes	Login time	`2022-07-03T02:20:30.000Z`
clientIp	string	yes	Client IP used for login	`127.0.0.1`
success	boolean	yes	Login success or failure	`true`
errorMessage	string	no	Specific error message when login fails	`Incorrect account or password`
userAgent	string	yes	User Agent	`Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36`
parsedUserAgent	yes	Parsed User Agent Nested type: ParsedUserAgent.
loginMethod	string	yes	Login method to use	`loginByEmail`
geoip	yes	Geolocation Nested type: GeoIp.
tenantId	string	no	Tenant ID	`642c1df417c2d8a80d744c1d`

¶ ParsedUserAgent

Name	Type	Required	Description	Sample value
device	string	Yes	Device type used	`Desktop`
browser	string	Yes	Browser name	`Chrome`
os	string	Yes	Operating system	`Windows`

¶ GeoIp

Name	Type	Required	Description	Sample value
location	Yes	Geographic location Nested type: GeoIpLocation.
country_name	string	Yes	Country Name	`China`
country_code2	string	Yes	Country Code 2	`CN`
country_code3	string	Yes	Country Code 3	`CN`
region_name	string	Yes	Region Name	`Beijing`
region_code	string	Yes	Region Code	`BJ`
city_name	string	Yes	City Name	`Beijing`
continent_code	string	Yes	Continent Code	`AS`
timezone	string	Yes	Time Zone	`Asia/Shanghai`

¶ GeoIpLocation

Name	Type	Required	Description	Sample value
lon	number	Yes	Longitude	`116.3889`
lat	number	Yes	Latitude	`39.9288`

Previous article: Get Available MFA Factors Next article: Get Logged In Applications

¶ Get login log

¶ Method name

¶ Request parameters

¶ Request response

¶ Data structure

¶ LoginHistoryPaginatedRespDto

¶ LoginHistoryDto

¶ ParsedUserAgent

¶ GeoIp

¶ GeoIpLocation