Update User Information¶

Update User Information

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/user/info/update

Request Parameters (URI)¶

Name	Mandatory/Optional	Data Type	Description
orgId	Mandatory	String	OU ID
userId	Optional	String	User ID
userName	Optional	String	User name

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
phone	Optional	String	User phone number
nickName	Optional	String	User nickname
phoneArea	Optional	String	The area code of user phone number
company	Optional	String	User company
position	Optional	String	User position in company
department	Optional	String	User department in company
email	Optional	String	User email. You cannot change the email of a domain user, if the email is the only access token for the domain.

Response Parameters¶

Name	Data Type	Description
data	data Struct	The updated user information

Data Struct¶

Name	Data Type	Description
nickName	String	User nickname
description	String	User description
isInitPassword	Boolean	Whether user’s password is the initial password
phone	String	User phone number
domain	String	User domain
name	String	User name
phoneArea	String	The area code of user phone number
createdTime	String	The time when the account was created
theme	String	System theme
company	String	user company
id	String	User ID
position	String	User position in company
department	String	User department in company
email	String	User email
updatedTime	String	The update time of the user information.

Error Codes¶

Codes	Description
31400	OU ID is required. At least one of userId and userName is required. Email already exists. Phone number, email, or area code is invalid.
31404	OU ID, user ID, or user name does note exist. User is not in the OU.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/user/info/update?userName=your_user_name&orgId=your_org_id

method: POST

requestBody:
{
  "phone": "your_phone_number",
  "nickName": "",
  "phoneArea": "+86",
  "company": "company",
  "position": "position",
  "department": "department",
  "email": "your_user_email"
}

Request Sample¶

{
    "code": 0,
    "data": {
        "nickName": "",
        "description": "",
        "isInitPassword": false,
        "phone": "your_phone_number",
        "domain": "",
        "name": "your_name",
        "phoneArea": "+86",
        "createdTime": "2021-10-09 03:36:53.0",
        "theme": "DARK",
        "company": "company",
        "id": "your_user_id",
        "position": "position",
        "department": "department",
        "email": "your_user_email"
    },
    "message": "OK"
}