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 this document description is incorrect, please refer to V3 API.

Get login log

¶ Method Name

AuthenticationClient.getLoginHistory

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
appId	string	No	-	Application ID, can be filtered based on application ID. Not passed by default. Get login history of all applications.	`5f6265c67fxxxxae64ec516e`
clientIp	string	No	-	Client IP, can be filtered based on client IP at login. Not passed by default. Get login history of all login IPs.	`127.0.0.1`
success	boolean	No	-	Yes. Whether login is successful or not. Can be filtered based on whether login is successful or not. Not passed by default. The acquired records contain both successful and failed login history.	`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`

¶ Sample Code

package test.authentication;

import cn.authing.sdk.java.client.AuthenticationClient;
import cn.authing.sdk.java.dto.GetLoginHistoryRespDto;
import cn.authing.sdk.java.dto.GetMyLoginHistoryDto;
import cn.authing.sdk.java.model.AuthenticationClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class GetLoginHistoryTest {
    // Need to be replaced with your GenAuth App ID
    private static final String APP_ID = "AUTHING_APP_ID";
    // Need to be replaced with your GenAuth App Secret
    private static final String APP_SECRET = "AUTHING_APP_SECRET";
    // Need to be replaced with your GenAuth App Host
    private static final String APP_HOST = "AUTHING_APP_HOST";
    // Need to be replaced with your GenAuth Access Token
    private static final String ACCESS_TOKEN = "AUTHING_ACCESS_TOKEN";

    public static void main(String[] args) throws Throwable {
        AuthenticationClientOptions clientOptions = new AuthenticationClientOptions();
        clientOptions.setAppId(APP_ID);
        clientOptions.setAppSecret(APP_SECRET);
        clientOptions.setAppHost(APP_HOST);
        clientOptions.setAccessToken(ACCESS_TOKEN);

        AuthenticationClient client = new AuthenticationClient(clientOptions);

        GetMyLoginHistoryDto reqDto = new GetMyLoginHistoryDto();
        GetLoginHistoryRespDto response = client.getLoginHistory(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type: GetLoginHistoryRespDto

Name	Type	Description
statusCode	number	Business status code. You can use this status code to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segment error code, through which you can get the specific error type (successful request does not return). 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

Example Results：

{
  "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": "Incorrect account or password",
      "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	Example Value
totalCount	number	Yes	Total number of records
list	array	Yes	Record list NestedType: LoginHistoryDto.

¶ LoginHistoryDto

Name	Type	Is it required	Description	Example 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	Yes whether the login was successful	`true`
errorMessage	string	No	Specific error message when login failed	`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 NestedType: ParsedUserAgent.
loginMethod	string	Yes	Login method used	`loginByEmail`
geoip	Yes	Geographic location NestedType: GeoIp.
tenantId	string	No	Tenant ID	`642c1df417c2d8a80d744c1d`

¶ ParsedUserAgent

Name	Type	Is it required	Description	Example Value
device	string	Yes	Type of device used	`Desktop`
browser	string	Yes	Browser Name	`Chrome`
os	string	Yes	Operating System	`Windows`

¶ GeoIp

Name	Type	Is it required	Description	Example Value
location	Yes	Geographic location Nested Type: GeoIpLocation.
lon	number	Yes	longitude	`116.3889`
lat	number	Yes	latitude	`39.9288`

Previous article: Get bindable MFA authentication factors Next article: Get login application

¶ Get login log

¶ Method Name

¶ Request Parameters

¶ Sample Code

¶ Request Response

¶ Data Structure

¶ LoginHistoryPaginatedRespDto

¶ LoginHistoryDto

¶ ParsedUserAgent

¶ GeoIp