¶ 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.getProfile

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
withCustomData	boolean	No	-	YesNo get custom data	`true`
withIdentities	boolean	No	-	YesNo get identities	`true`
withDepartmentIds	boolean	No	-	YesNo get department ID list	`true`

¶ Sample Code

package test.authentication;

import cn.authing.sdk.java.client.AuthenticationClient;
import cn.authing.sdk.java.dto.GetProfileDto;
import cn.authing.sdk.java.dto.UserSingleRespDto;
import cn.authing.sdk.java.model.AuthenticationClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class GetProfileTest {
    // 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);

        UserSingleRespDto response = client.getProfile(new GetProfileDto());
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type: UserSingleRespDto

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	UserDto	Response Data

Example Results：

{
  "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": "San",
    "familyName": "Zhang",
    "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": "Beijing University",
      "age": 22
    },
    "statusChangedAt": "2022-07-03T03:20:30.000Z"
  }
}

¶ Data Structure

¶ UserDto

Name	Type	Is it required	Description	Example 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 overseas 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 yet 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	User name, 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, `male` - `F`: Female, `female` - `U`: Unknown, `unknown`	M
emailVerified	boolean	Yes	Is the email verified?	`true`
phoneVerified	boolean	Yes	Is the mobile phone number verified?	`true`
passwordLastSetAt	string	No	The time when the user last changed his password	`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	`Beijing Chaoyang`
streetAddress	string	No	Street Address	`Beijing Chaoyang District xxx Street`
postalCode	string	No	Postal Code	`438100`
company	string	No	Company	`steamory`
browser	string	No	Last browser used 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	The device used when logging in last time	`iOS`
givenName	string	no	first name	`San`
familyName	string	no	last name	`Zhang`
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`: via excel Import - `register`: User self-registration - `adminCreated`: Manual creation by the administrator (including creating users using the management API) - `syncTask`: Synchronization task of the Sync 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	User's department ID list	`["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]`
identities	array	No	External identity source NestedType: IdentityDto。
identityNumber	string	No	User ID number	`420421xxxxxxxx1234`
customData	object	No	User's extended field data	`{"school":"Beijing University","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 it required	Description	Example 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-type enterprise identity source - `oauth2`: OAuth2-type enterprise identity source - `saml`: SAML-type enterprise identity source - `ldap`: LDAP-type enterprise identity source - `ad`: AD-type enterprise identity source - `cas`: CAS-type enterprise identity source - `azure-ad`: Azure AD-type 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 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 the identity comes	`["605492ac41xxxxe0362f0707"]`

Previous article: Back-end logout Next article: Modify user information