Views:
Last updated: 12/05/2023 11:10:05 AM
Note
Note
Business role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
This API is used to retrieve all user profiles under specified customer company.

Request

HTTP Request

[GET] /LMPI/v2/customers/{customer_id}/users

Parameters

Name
Type
Description
Validation
Required Parameters
customer_id
string
The unique identifier of customer company that users belong to.
GUID format
Optional Parameters
page
integer
The page number you want to query.
Positive integer, default value: 1
limit
integer
The number of records per page.
Positive integer (1-100), default value: 25

HTTP Request Example

[GET] https://{lmpi-fqdn}/LMPI/v2/customers/3e75316a-5d82-4cdc-8c00-4219527c07da/users
Do not supply a request body with this method.

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"paging": {
        "total": 1, 
        "limit": 25, 
        "page": 1
        }, 
"users": [{
        "status": 1, 
        "first_name": "TM_AT", 
        "last_name": "001", 
        "user_id": "300d03d8-851e-46e3-bbb5-59e96bbeaabf", 
        "language": "en-US", 
        "time_zone": "Pacific Standard Time", 
        "email": "terry_liu@trend.com.tw", 
        "phone": {
                  "area_code": "818", 
                  "number": "907-7112", 
                  "extension": null}, 
        "login_name": "TM_AT41212172035229"
        } ]
}
Name
Type
Description
Length
paging.total
integer
The total number of records.
Positive integer
paging.limit
integer
The number of records per page.
Positive integer
paging.page
integer
The current page number.
Positive integer (1-max)
users[].user_id
string
The unique identifier of current user account.
GUID format
users[].status
integer
The status of current user account. 0: disabled. 1: enabled.
1 digit
users[].login_name
string
The login name of user account, used to sign in to Customer Licensing Portal.
4-25 characters
users[].first_name
string
The current user's first name.
1-50 characters
users[].last_name
string
The current user's last name.
1-50 characters
users[].email
string
The current user's contact email.
1-128 characters
users[].time_zone
string
The preferred time zone.
Valid time zone (e.g. Pacific Standard Time)
users[].language
string
The preferred language code, used to determine the language preference of Customer Licensing Portal.
Valid language code (e.g. en-US)
users[].phone.area_code
string
The area code of user's contact phone number.
Positive integer, 0-5 digits
users[].phone.number
string
The contact phone number of the user.
0-16 characters (limited to numbers, plus signs, minus signs, periods, brackets)
users[].phone.extension
string
The extension of user's contact phone number.
Positive integer (0-10)