GET v2/Users/all?SearchSubCustomers={SearchSubCustomers}
Get all users associated with the requester's customer account.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SearchSubCustomers |
If true, the query will also return entities belonging to child customers of the requested customer. |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.UserName | Description | Type | Additional information |
---|---|---|---|
UserId |
The user ID |
integer |
None. |
CustomerId |
The owning customer ID |
integer |
None. |
UserName |
The user name |
string |
None. |
EmailAddress |
The user's email address |
string |
None. |
NameFirst |
The user's first name |
string |
None. |
NameLast |
The user's last name |
string |
None. |
PhoneOffice |
The user's office phone number |
string |
None. |
PhoneMobile |
The user's mobile phone number |
string |
None. |
PreferredLocale |
The user's preferred locale |
string |
None. |
PreferredTimeZone |
The user's preferred time zone |
string |
None. |
PreferredUnitSystem |
The user's preferred unit system |
Lhp.EquipmentIntelligence.WebApi.Client.Models.UnitSystems |
None. |
PreferredDecimalPlaces |
The user's preferred number of decimal places |
integer |
None. |
PreferredFirstDayOfWeek |
The user's preferred first day of week |
System.DayOfWeek |
None. |
SignedEulaTimestamp |
Indicates the date and time when the user signed a EULA, or null if they have not signed. |
date |
None. |
SignedEulaRevision |
The revision of the EULA the user most recently signed, or null if the user has never signed a EULA. |
string |
None. |
LastSuccessfulLoginOn |
The timestamp of the last successful login by this user, or null of never logged in. |
date |
None. |
Response Formats
application/json, text/json
[ { "UserId": 1, "CustomerId": 2, "UserName": "sample string 3", "EmailAddress": "sample string 4", "NameFirst": "sample string 5", "NameLast": "sample string 6", "PhoneOffice": "sample string 7", "PhoneMobile": "sample string 8", "PreferredLocale": "sample string 9", "PreferredTimeZone": "sample string 10", "PreferredUnitSystem": 0, "PreferredDecimalPlaces": 11, "PreferredFirstDayOfWeek": 0, "SignedEulaTimestamp": "2024-09-07T17:52:01.0773693+00:00", "SignedEulaRevision": "sample string 12", "LastSuccessfulLoginOn": "2024-09-07T17:52:01.0773693+00:00" }, { "UserId": 1, "CustomerId": 2, "UserName": "sample string 3", "EmailAddress": "sample string 4", "NameFirst": "sample string 5", "NameLast": "sample string 6", "PhoneOffice": "sample string 7", "PhoneMobile": "sample string 8", "PreferredLocale": "sample string 9", "PreferredTimeZone": "sample string 10", "PreferredUnitSystem": 0, "PreferredDecimalPlaces": 11, "PreferredFirstDayOfWeek": 0, "SignedEulaTimestamp": "2024-09-07T17:52:01.0773693+00:00", "SignedEulaRevision": "sample string 12", "LastSuccessfulLoginOn": "2024-09-07T17:52:01.0773693+00:00" } ]
application/xml, text/xml
<ArrayOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <User> <UserId>1</UserId> <CustomerId>2</CustomerId> <UserName>sample string 3</UserName> <EmailAddress>sample string 4</EmailAddress> <NameFirst>sample string 5</NameFirst> <NameLast>sample string 6</NameLast> <PhoneOffice>sample string 7</PhoneOffice> <PhoneMobile>sample string 8</PhoneMobile> <PreferredLocale>sample string 9</PreferredLocale> <PreferredTimeZone>sample string 10</PreferredTimeZone> <PreferredUnitSystem>None</PreferredUnitSystem> <PreferredDecimalPlaces>11</PreferredDecimalPlaces> <PreferredFirstDayOfWeek>Sunday</PreferredFirstDayOfWeek> <SignedEulaTimestamp>2024-09-07T17:52:01.0773693+00:00</SignedEulaTimestamp> <SignedEulaRevision>sample string 12</SignedEulaRevision> <LastSuccessfulLoginOn>2024-09-07T17:52:01.0773693+00:00</LastSuccessfulLoginOn> </User> <User> <UserId>1</UserId> <CustomerId>2</CustomerId> <UserName>sample string 3</UserName> <EmailAddress>sample string 4</EmailAddress> <NameFirst>sample string 5</NameFirst> <NameLast>sample string 6</NameLast> <PhoneOffice>sample string 7</PhoneOffice> <PhoneMobile>sample string 8</PhoneMobile> <PreferredLocale>sample string 9</PreferredLocale> <PreferredTimeZone>sample string 10</PreferredTimeZone> <PreferredUnitSystem>None</PreferredUnitSystem> <PreferredDecimalPlaces>11</PreferredDecimalPlaces> <PreferredFirstDayOfWeek>Sunday</PreferredFirstDayOfWeek> <SignedEulaTimestamp>2024-09-07T17:52:01.0773693+00:00</SignedEulaTimestamp> <SignedEulaRevision>sample string 12</SignedEulaRevision> <LastSuccessfulLoginOn>2024-09-07T17:52:01.0773693+00:00</LastSuccessfulLoginOn> </User> </ArrayOfUser>