¶ 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 the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If this document description is incorrect, please refer to the V3 API.

This endpoint user obtains user information and needs to bring the user's access_token in the request header. The GenAuth server will return the corresponding fields based on the scope in the user's access_token.

¶ Method name

AuthenticationClient.get_profile

¶ Request parameters

Name	Type	Required	Default value	Description	Sample value
withCustomData	boolean	No	-	Get custom data	`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

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "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": "Zhang San",
    "nickname": "Zhang San",
    "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 ": "Beijing Chaoyang",
    "streetAddress": "Beijing Chaoyang District xxx Street",
    "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": "Peking University", "age": 22 },
    "statusChangedAt": "2022-07-03T03:20:30.000Z"
  }
}

¶ Data Structure

¶ 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 address, mobile phone number, externalId, or ID in the external identity source. For details, see the description of the userIdType field. The default value 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 a foreign mobile number, please specify the area code in the phoneCountryCode parameter.	`188xxxx8888`
phoneCountryCode	string	no	Mobile phone area code. This field is optional for mobile phone numbers in mainland China. 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 within 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	Historical total login count	`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	Email verification status	`true`
phoneVerified	boolean	yes	Phone number verification status	`true`
passwordLastSetAt	string	no	User's last password modification time	`2022-07-03T03:20:30.000Z`
birthdate	string	no	Birthdate	`2022-06-03`
country	string	no	Country	`CN`
province	string	no	Province	`BJ`
city	string	no	City	`BJ`
address	string	no	Address	`xxxx`
streetAddress	string	no	Street address	`xxxx`
postalCode	string	no	Postal code	`438100`
company	string	no	Company	`steamory`
browser	string	no	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	string	no	Device	`iOS`
givenName	string	no	Given name	`xxx`
familyName	string	no	Family name	`xxx`
middleName	string	no	Middle name	`James`
profile	string	no	Preferred Username	`alice`
preferredUsername	string	no	Preferred Username	`alice`
website	string	no	Website	`https://my-website.com`
zoneinfo	string	no	Time zone information	`GMT-08:00`
locale	string	no	Locale	`af`
formatted	string	no	Standardized 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`: Import via excel - `register`: User self-registration - `adminCreated`: Admin manually creates user (includes using admin API to create user) - `syncTask`: Sync task in sync center	excel
userSourceId	string	No	Application ID or sync task ID
lastLoginApp	string	No	User's last login application ID
mainDepartmentId	string	No	User's main department ID
lastMfaTime	string	No	User's last MFA authentication time
passwordSecurityLevel	number	No	User's password security strength level	`1`
resetPasswordOnNextLogin	boolean	No	Next login requires password reset
registerSource	array	No	Registration method
departmentIds	array	No	User's department ID list	`["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]`
identities	array	No	External identity source nested type：IdentityDto。
identityNumber	string	No	User's identity number	`420421xxxxxxxx1234`
customData	object	No	User's extended field data	`{"school":"xxxx","age":22}`
postIdList	array	No	User's post ID list
statusChangedAt	string	No	User's status last modified time	`2022-07-03T03:20:30.000Z`
tenantId	string	No	User's tenant ID

¶ IdentityDto

Name	Type	Is it required?	Description	Sample value
identityId	string	Yes	Identity ID	`62299d8b866d2dab79a89dc4`
extIdpId	string	Yes	Identity Connection ID	`6076bacxxxxxxxxd80d993b5`
provider	string	yes	External identity source type: - `wechat`: WeChat - `qq`: QQ - `wechatwork`: WeChat Work - `dingtalk`: DingTalk - `weibo`: Weibo - `github`: GitHub - `alipay`: Alipay - `baidu`: Baidu - `lark`: Feishu - `welink`: Welink - `yidun`: NetEase Yidun - `qingcloud`: QingCloud - `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 the external identity source	`oj7Nq05R-RRaqak0_YlMLnnIwsvg`
userInfoInIdp	object	yes	User's identity information in idp
accessToken	string	no	Access Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	`57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx`
refreshToken	string	no	Refresh Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	`57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx`
originConnIds	array	yes	Identity source connection ID list from which the identity comes	`["605492ac41xxxxe0362f0707"]`

Previous article: Register Next article: Update User Profile