¶ Get user information

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 user details through user ID, you can choose to get custom data, identities, select a specified user ID type, etc.

¶ Method name

ManagementClient.get_user

¶ Request parameters

Name	Type	Required	Default value	Description	Sample value
userId	string	yes	-	User ID	`6229ffaxxxxxxxxcade3e3d9`
userIdType	string	no	user_id	User ID type, the default value is `user_id`, the optional values are: - `user_id`: GenAuth user ID, such as `6319a1504f3xxxxf214dd5b7` - `phone`: User phone number - `email`: User email - `username`: User name - `external_id`: User ID in the external system, corresponding to the `externalId` field of GenAuth user information - `identity`: User's external identity source information, in the format of `<extIdpId>:<userIdInIdp>`, where `<extIdpId>` is the ID of the GenAuth identity source, and `<userIdInIdp>` is the ID of the user. The ID of the user in the external identity source. Example value: `62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`. - `sync_relation`: The user's external identity source information, in the format of `<provier>:<userIdInIdp>`, where `<provier>` is the synchronization identity source type, such as wechatwork, lark; `<userIdInIdp>` is the ID of the user in the external identity source. Example value: `lark:ou_8bae746eac07cd2564654140d2a9ac61`.	`user_id`
flatCustomData	boolean	no	-	Whether to flatten the extended field
withCustomData	boolean	no	-	Whether to obtain custom data	`true`
withPost	boolean	no	-	Whether to obtain department information	`true`
withIdentities	boolean	no	-	Get identities	`true`
withDepartmentIds	boolean	no	-	Get department ID list	`true`

¶ Request Response

Type: UserSingleRespDto

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

Example results:

{
  "statusCode": 200,
  "message": "Success",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "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": "xxx",
    "nickname": "xxx",
    "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

¶ UserDto

Name	Type	Is this field required?	Description	Sample value
userId	string	Yes	The unique identifier of the user, which can be user ID, user name, email, phone 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	Phone number without area code. If it is an international phone number, please specify the area code in the phoneCountryCode parameter.	`188xxxx8888`
phoneCountryCode	string	No	Phone area code. This parameter is optional for phone numbers in mainland China. The GenAuth SMS service does not currently support international phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of 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	`xxx`
nickname	string	no	Nickname	`xxx`
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, `male` - `F`: Female, `female` - `U`: Unknown, `unknown`	M
emailVerified	boolean	yes	Is email verified?	`true`
phoneVerified	boolean	yes	Is 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	The browser used when logging in last	`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	The device used when logging in last	`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's personal website	`https://my-website.com`
zoneinfo	string	no	User time zone information	`GMT-08:00`
locale	string	no	Locale	`af`
formatted	string	no	Standard full address	`132, My Street, Kingston, New York 12401.`
region	string	no	User's region	`Xinjiang Uyghur Autonomous Region`
userSourceType	string	yes	Source type: - `excel`: Imported via excel - `register`: User self-registration - `adminCreated`: Manual creation by the administrator backend (including creating users using the management API) - `syncTask`: Sync task in the sync center	excel
userSourceId	string	no	Application ID or sync 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 when the user last performed 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's identity information in idp
accessToken	string	no	Access Token in external identity source (this parameter is returned only when user actively obtains it, and it is not returned by management interface).	`57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx`
refreshToken	string	no	Refresh Token in external identity source (this parameter is returned only when user actively obtains it, and it is not returned by management interface).	`57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx`
originConnIds	array	yes	Identity source connection ID list from which identity comes	`["605492ac41xxxxe0362f0707"]`

Previous article: Get User List Next article: Batch Get User Information