¶ Get the currently logged in user of the application

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 the user who is currently logged in to the application

¶ Method name

ManagementClient.list_application_active_users

¶ Request parameters

Name	Type	Required	Default value	Description	Sample value
appId	string	Yes	-	Application ID	`6229ffaxxxxxxxxcade3e3d9`
options	ListApplicationActiveUsersOptionsDto	No	-	Optional

¶ Request Response

Type: UserPaginatedRespDto

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 (successful request does not return). For a detailed list of error codes, please see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	UserPagingDto	Response data

Example results:

{
  "statusCode": 200,
  "message": "Success",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "userId": "6229ffaxxxxxxxxcade3e3d9",
      "createdAt": "2022-07-03T03:20:30.000Z",
      "updatedAt": "2022-07-03T03:20:30.000Z",
      "status": "Activated",
      "workStatus": "Active",
      "externalId": "10010",
      "email": "test@example.com",
      "phone": "188xxxx8888",
      "phoneCountryCode": "+86",
      "username": "bob",
      "name": "xxxx",
      "nickname": "xxxx",
      "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
      "loginsCount": 3,
      "lastLogin": "2022-07-03T03:20:30.000Z",
      "lastIp": "127.0.0.1",
      "gender": "M",
      "emailVerified": true,
      "phoneVerified": true,
      "passwordLastSetAt": "2022-07-03T03:20:30.000Z",
      "birthdate": "2022-06-03",
      "country": "CN",
      "province": "BJ",
      "city": "BJ",
      "address": "xxxxx",
      "streetAddress": "xxxxx",
      "postalCode": "438100",
      "company": "steamory",
      "browser": "Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0",
      "device": "iOS",
      "givenName": "xx",
      "familyName": "xxx",
      "middleName": "James",
      "profile": "alice",
      "preferredUsername": "alice",
      "website": "https://my-website.com",
      "zoneinfo": "GMT-08:00",
      "locale": "af",
      "formatted": "132, My Street, Kingston, New York 12401.",
      "region": "Xinjiang Uyghur Autonomous Region",
      "userSourceType": "register",
      "passwordSecurityLevel": 1,
      "departmentIds": "[\"624d930c3xxxx5c08dd4986e\",\"624d93102xxxx012f33cd2fe\"]",
      "identities": {
        "identityId": "62299d8b866d2dab79a89dc4",
        "extIdpId": "6076bacxxxxxxxxd80d993b5",
        "provider": "wechat",
        "type": "openid",
        "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
        "accessToken": "57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx",
        "refreshToken": "57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx",
        "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
      },
      "identityNumber": "420421xxxxxxxx1234",
      "customData": {
        "school": "xxxxx",
        "age": 22
      },
      "statusChangedAt": "2022-07-03T03:20:30.000Z"
    }
  }
}

¶ Data Structure

¶ ListApplicationActiveUsersOptionsDto

Name	Type	Is it required?	Description	Sample value
pagination	No	Pagination configuration Nested type: PaginationDto.	`{"page":1,"limit":10}`
withCustomData	boolean	No	Get custom data?	`true`
withIdentities	boolean	No	Get identities?	`true`
withDepartmentIds	boolean	No	Get department ID list?	`true`

¶ PaginationDto

Name	Type	Required	Description	Sample value
page	number	No	Current page number, starting from 1	`1`
limit	number	No	Number per page, maximum cannot exceed 50, default is 10	`10`

¶ UserPagingDto

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

¶ UserDto

Name	Type	Is it required?	Description	Sample value
userId	string	yes	The unique identifier of the user, which can be user ID, user name, email, mobile number, externalId, or ID in an external identity source. For details, see the description of the userIdType field. The default is user id.	`6229ffaxxxxxxxxcade3e3d9`
createdAt	string	yes	Creation time	`2022-07-03T03:20:30.000Z`
updatedAt	string	yes	Update time	`2022-07-03T03:20:30.000Z`
status	string	yes	Current status of the account: - Activated: Normal status - Suspended: Deactivated - Deactivated: Disabled - Resigned: Resigned - Archived: Archived	Suspended
workStatus	string	yes	Current work status of the account	Closed
externalId	string	no	Third-party external ID	`10010`
email	string	no	Email address, case-insensitive	`test@example.com`
phone	string	no	Mobile number without area code. If it is an overseas mobile number, please specify the area code in the phoneCountryCode parameter.	`188xxxx8888`
phoneCountryCode	string	No	Mobile phone area code. This field is optional for mainland China mobile phone numbers. The GenAuth SMS service does not yet support international mobile phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of mobile phone area codes, please refer to https://en.wikipedia.org/wiki/List_of_country_calling_codes.	`+86`
username	string	No	Username, unique in the user pool	`bob`
name	string	No	User's real name, not unique	`Zhang San`
nickname	string	No	Nickname	`Zhang San`
photo	string	No	Avatar link	`https://files.authing.co/authing-console/default-user-avatar.png`
loginsCount	number	No	Total number of historical logins	`3`
lastLogin	string	No	Last login time	`2022-07-03T03:20:30.000Z`
lastIp	string	no	Last login IP	`127.0.0.1`
gender	string	yes	Gender: - `M`: Male - `F`: Female - `U`: Unknown	M
emailVerified	boolean	yes	Email verified	`true`
phoneVerified	boolean	yes	Phone number verified	`true`
passwordLastSetAt	string	no	User's last password modification time	`2022-07-03T03:20:30.000Z`
birthdate	string	no	Date of birth	`2022-06-03`
country	string	no	Country	`CN`
province	string	no	Province	`BJ`
city	string	no	City	`BJ`
address	string	no	Address	`xxxxx`
streetAddress	string	no	Street Address	`xxxxx`
postalCode	string	no	Postal Code	`438100`
company	string	no	Company	`steamory`
browser	string	no	Last login browser UA	`Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0`
device	string	no	Last login device	`iOS`
givenName	string	no	First name	`xx`
familyName	string	no	Last name	`xxx`
middleName	string	no	Middle name	`James`
profile	string	no	Preferred Username	`alice`
preferredUsername	string	no	Preferred Username	`alice`
website	string	no	User personal website	`https://my-website.com`
zoneinfo	string	no	User time zone information	`GMT-08:00`
locale	string	no	Locale	`af`
formatted	string	no	Full standard address	`132, My Street, Kingston, New York 12401.`
region	string	no	User location	`Xinjiang Uyghur Autonomous Region`
userSourceType	string	yes	Source type: - `excel`: Imported through excel - `register`: User self-registration - `adminCreated`: Manual creation by the administrator backend (including creating users using the management API) - `syncTask`: Synchronization task of the synchronization center	excel
userSourceId	string	No	Application ID or synchronization task ID
lastLoginApp	string	No	Application ID of the user's last login
mainDepartmentId	string	No	User's main department ID
lastMfaTime	string	No	Time of the user's last MFA authentication
passwordSecurityLevel	number	No	User password security strength level	`1`
resetPasswordOnNextLogin	boolean	No	Require password reset on next login
registerSource	array	No	Registration method
departmentIds	array	no	List of department IDs to which the user belongs	`["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]`
identities	array	no	External identity source Nested type: IdentityDto.
identityNumber	string	No	User ID number	`420421xxxxxxxx1234`
customData	object	No	User's extended field data	`{"school":"xxxxx","age":22}`
postIdList	array	No	User-associated department ID
statusChangedAt	string	No	User status last modified time	`2022-07-03T03:20:30.000Z`
tenantId	string	No	User tenant ID

¶ IdentityDto

Name	Type	Is this field required?	Description	Sample value
identityId	string	yes	Identity source ID	`62299d8b866d2dab79a89dc4`
extIdpId	string	yes	Identity source connection ID	`6076bacxxxxxxxxd80d993b5`
provider	string	yes	External identity source type: - `wechat`: WeChat - `qq`: QQ - `wechatwork`: WeChat for Business - `dingtalk`: DingTalk - `weibo`: Weibo - `github`: GitHub - `alipay`: Alipay - `baidu`: Baidu - `lark`: Feishu - `welink`: Welink - `yidun`: NetEase Yidun - `qingcloud`: Qingyun - `google`: Google - `gitlab`: GitLab - `gitee`: Gitee - `twitter`: Twitter - `facebook`: Facebook - `slack`: Slack - `linkedin`: Linkedin - `instagram`: Instagram - `oidc`: OIDC-based enterprise identity source - `oauth2`: OAuth2-based enterprise identity source - `saml`: SAML-based enterprise identity source - `ldap`: LDAP-based enterprise identity source - `ad`: AD-based enterprise identity source - `cas`: CAS-based enterprise identity source - `azure-ad`: Azure AD-based enterprise identity source	oidc
type	string	Yes	Identity type, such as unionid, openid, primary	`openid`
userIdInIdp	string	Yes	ID in external identity source	`oj7Nq05R-RRaqak0_YlMLnnIwsvg`
userInfoInIdp	object	Yes	User identity information in idp
accessToken	string	No	Access Token in external identity source (this parameter is returned only when the user actively obtains it, and the management interface will not return it).	`57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx`
refreshToken	string	No	Refresh Token in external identity source (this parameter is returned only when the user actively obtains it, and the management interface will not return it).	`57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx`
originConnIds	array	yes	List of identity origin connection IDs that the identity came from	`["605492ac41xxxxe0362f0707"]`

Previous article: 刷新应用密钥 Next article: 获取应用默认访问授权策略