Last updated: 11/18/2024 10:33:51 AM
 |
NoteBusiness role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
|
This API is used to update specified user profile. The modified data will be returned
in API response for verification, and can also be retrieved from API Customers :: Query .
 |
ImportantThis feature is unavailable for Trend Vision One users. Trend Vision One users can
go to Account Settings in the Trend Vision One console to update user profile information.
|
Request
HTTP Request
[PUT] /LMPI/v2/customers/{customer_id}/users/{user_id}
Parameters
|
Name
|
Type
|
Description
|
Validation
|
|
Required Parameters
|
|||
|
customer_id
|
string
|
The unique identifier of customer company that user in need of update belongs to.
|
GUID format
|
|
user_id
|
string
|
The unique identifier of user account that user profile in need of update belongs
to.
|
GUID format
|
HTTP Request Example
[PUT] https://{lmpi-fqdn}/LMPI/v2/customers/cdc8c54a-951c-4a85-9c76-46c3af765cb8/users/87007af3-439e-497a-86ce-b264a5bceed3
Request Body
{
"last_name":"61108174658823",
"email":"i8zPDKKi@yopmail.com"
}
|
Name
|
Type
|
Description
|
Validation
|
|
Optional Parameters
|
|||
|
first_name
|
string
|
The user's updated first name.
|
1-50 characters
|
|
last_name
|
string
|
The user's updated last name.
|
1-50 characters
|
|
email
|
string
|
The user's new contact email.
|
1-128 characters
|
|
time_zone
|
string
|
The new preferred time zone.
|
Valid time zone (e.g. Pacific Standard Time)
|
|
language
|
string
|
The new preferred language code.
|
Valid language code (e.g. en-US)
|
|
phone.area_code
|
string
|
The area code of user's new contact phone number.
|
Positive integer, 0-5 digits
|
|
phone.number
|
string
|
The new contact phone number.
|
0-16 characters (limited to numbers, plus signs, minus signs, periods, and brackets)
|
|
phone.extension
|
string
|
The extension of user's new contact phone number.
|
Positive integer, 0-10 digits
|
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body
with the following structure:
{
"first_name": "TM_Auto",
"last_name": "61108174658823",
"user_id": "87007af3-439e-497a-86ce-b264a5bceed3",
"language": "en-US",
"time_zone": "GMT Standard Time",
"phone": {
"area_code": "",
"number": "",
"extension": ""
},
"email": "i8zPDKKi@yopmail.com"
}
|
Name
|
Type
|
Description
|
Length
|
|
user_id
|
string
|
The unique identifier of user.
|
GUID format
|
|
first_name
|
string
|
The updated first name. If not updated, this field will be returned with original
data.
|
1-50 characters
|
|
last_name
|
string
|
The updated last name. If not updated, this field will be returned with original data.
|
1-50 characters
|
|
email
|
string
|
The updated contact email. If not updated, this field will be returned with original
data.
|
1-128 characters
|
|
time_zone
|
string
|
The updated preferred time zone. If not updated, this field will be returned with
original data.
|
Valid time zone (e.g. Pacific Standard Time)
|
|
language
|
string
|
The updated preferred language code. If not updated, this field will be returned with
original data.
|
Valid language code (e.g. en-US)
|
|
phone.area_code
|
string
|
The updated contact phone number area code. If not updated, this field will be returned
with original data.
|
Positive integer, 0-5 digits
|
|
phone.number
|
string
|
The updated contact phone number. If not updated, this field will be returned with
original data.
|
0-16 characters (limited to numbers, plus signs, minus signs, periods, and brackets)
|
|
phone.extension
|
string
|
The updated contact phone number extension. If not updated, this field will be returned
with original data.
|
Positive integer, 0-10 digits
|