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

This interface is used to modify the user's user information, including the user's custom data. If you need to change email, change mobile phone number, change password, please use the corresponding separate interface.

¶ Method name

AuthenticationClient.update_profile

¶ Request parameters

Name	Type	Required	Default value	Description	Sample value
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`
externalId	string	No	-	Third-party external ID	`10010`
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`
gender	string	no	U	Gender	`M`
username	string	no	-	Username, unique in the user pool	`bob`
company	string	no	-	Company	`steamory`
customData	object	no	-	Custom data, key in the passed object You must first define the relevant custom fields in the user pool	`{"school":"Peking University","age":22}`
identityNumber	string	No	-	User ID number	`420421xxxxxxxx1234`

¶ 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 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	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 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 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	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	Email verified	`true`
phoneVerified	boolean	yes	Phone number verified	`true`
passwordLastSetAt	string	no	User's last password change 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	`Beijing Chaoyang`
streetAddress	string	no	Street address	`xxx Street, Chaoyang District, Beijing`
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	`xxx`
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 URL	`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`: Synchronization task in 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 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":"Peking University","age":22}`
postIdList	array	No	Department ID associated with the user
statusChangedAt	string	No	Time when the user's status was last modified	`2022-07-03T03:20:30.000Z`
tenantId	string	No	User tenant ID

¶ IdentityDto

Name	Type	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`: QingCloud - `google`: Google - `gitlab`: GitLab - `gitee`: Gitee - `twitter`: Twitter - `facebook`: Facebook - `slack`: Slack - `linkedin`: Linkedin - `instagram`: Instagram - `oidc`: OIDC Enterprise Identity Source - `oauth2`: OAuth2 Type of enterprise identity source - `saml`: SAML type of enterprise identity source - `ldap`: LDAP type of enterprise identity source - `ad`: AD type of enterprise identity source - `cas`: CAS type of enterprise identity source - `azure-ad`: Azure AD type of 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	List of identity origin connection IDs that the identity came from	`["605492ac41xxxxe0362f0707"]`

Previous article: Get User Profile Next article: Bind Email