GET /service/api/securecloud/customers/{customerId}/users
?limit={limit}
&offset={offset}
Provides a paginated list of all users associated with an end customer.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
customerId |
A unique id by which an end customer is identified. |
string |
Required |
limit |
The maximum number of records to return. Valid values are between 10 and 1000. |
integer |
None. |
offset |
Specifies the number of records to skip, determining the starting point for displaying results. The record index starts from zero. |
integer |
None. |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/users?limit=15&offset=0
|
GET
|
https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/users?limit=10
|
Body Parameters
None.
Response Information
Resource Description
List of users associated with an end customer.
GetAllCustomerUsersResponseModelName | Description | Type | Additional Information |
---|---|---|---|
Users |
List of user detail records. |
Collection of GetUserResponseModel |
None. |
Links |
Pagination information. |
GetAllCustomerUsersResponseModelPageLinks |
None. |
Meta |
Additional information of the response. |
GetAllCustomerUsersResponseModelPageMeta |
None. |
Sample Response
{ "Users": [ { "UserId": "10b33726-fdba-4670-b7c3-22253ab8e778", "FirstName": "George Fr.", "LastName": "junior", "PhoneNumber": "1234567890", "EmailAddress": "gfj@etppro.com", "Roles": [ "Customer_Administrator", "Billing" ], "Culture": "en-US", "UserServices": [ { "ServiceName": "Email Threat Protection" } ] }, { "UserId": "6c2536a7-a02e-4090-92ca-d93a242480cc", "FirstName": "Kevin", "LastName": "Dey", "PhoneNumber": "1234567890", "EmailAddress": "kevinde@tsp.co.us", "Roles": [ "Billing" ], "Culture": "en-US", "UserServices": [ { "ServiceName": "Email Threat Protection" }, { "ServiceName": "Office365" } ] } ], "Links": { "NextPageLimit": 85, "NextPageOffset": 86 }, "Meta": { "Page": { "Total": 193 } } }
<GetAllCustomerUsersResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models"> <Links> <NextPageLimit>85</NextPageLimit> <NextPageOffset>86</NextPageOffset> </Links> <Meta> <Page> <Total>193</Total> </Page> </Meta> <Users> <GetUserResponseModel> <EmailAddress>gfj@etppro.com</EmailAddress> <FirstName>George Fr.</FirstName> <LastName>junior</LastName> <PhoneNumber>1234567890</PhoneNumber> <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>Customer_Administrator</d4p1:string> <d4p1:string>Billing</d4p1:string> </Roles> <Culture>en-US</Culture> <UserId>10b33726-fdba-4670-b7c3-22253ab8e778</UserId> <UserServices> <GetUserResponseModelUserService> <ServiceName>Email Threat Protection</ServiceName> </GetUserResponseModelUserService> </UserServices> </GetUserResponseModel> <GetUserResponseModel> <EmailAddress>kevinde@tsp.co.us</EmailAddress> <FirstName>Kevin</FirstName> <LastName>Dey</LastName> <PhoneNumber>1234567890</PhoneNumber> <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>Billing</d4p1:string> </Roles> <Culture>en-US</Culture> <UserId>6c2536a7-a02e-4090-92ca-d93a242480cc</UserId> <UserServices> <GetUserResponseModelUserService> <ServiceName>Email Threat Protection</ServiceName> </GetUserResponseModelUserService> <GetUserResponseModelUserService> <ServiceName>Office365</ServiceName> </GetUserResponseModelUserService> </UserServices> </GetUserResponseModel> </Users> </GetAllCustomerUsersResponseModel>