Update User Information¶
Update User Information
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 |
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 |
String | User email |
Error Codes¶
Codes | Description |
---|---|
31400 |
|
31404 |
|
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.2/user/info/update?userName=xxx&orgId=oxxxxxxxxxxx
method: POST
requestBody:
{
"phone": "181xxxxxxxx",
"nickName": "",
"phoneArea": "+86",
"company": "company",
"position": "position",
"department": "department",
"email": "xxx@mail.com"
}
Request Sample¶
{
"code": 0,
"data": {
"nickName": "",
"description": "",
"isInitPassword": false,
"phone": "181xxxxxxxx",
"domain": "",
"name": "xxx",
"phoneArea": "+86",
"createdTime": "2021-10-09 03:36:53.0",
"theme": "DARK",
"company": "company",
"id": "uxxxxxxxxx",
"position": "position",
"department": "department",
"email": "xxx@mail.com"
},
"message": "OK"
}