Unity API Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/admins

Gets the list of admins on a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required
siteId

The site identifier.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/19F9-E1B0-1978-4BBD-A23C/sites/c4f4498a-7f48-440c-8e93-5597b2addfcb/admins

Body Parameters

None.

Response Information

Resource Description

Information about the list of admins on a given GSM site.

GetGSMSiteAdminsResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of users available.

 integer

None.
Admins

List of user details records.

 Collection of GetGSMSiteAdminsResponseModel_Admin

None.

Sample Response

{
  "TotalCount": 2,
  "Admins": [
    {
      "UserId": "80d28ce6-225f-4f6c-91ce-4e28eda3dc57",
      "Email": "test1@webroot.com",
      "FirstName": "Test1",
      "LastName": "User1",
      "DisplayName": "Test1 User1",
      "MobileTel": "07365576",
      "OfficeTel": "01824428",
      "UserState": "Activated",
      "AccessLevel": 128,
      "MSPUser": false,
      "Confirmed": true
    },
    {
      "UserId": "1561f655-a4c0-421f-928b-91d60fa1c2e4",
      "Email": "test2@webroot.com",
      "FirstName": "Test2",
      "LastName": "User2",
      "DisplayName": "Test2 User2",
      "MobileTel": "07882988",
      "OfficeTel": "01141762",
      "UserState": "Activated",
      "AccessLevel": 128,
      "MSPUser": false,
      "Confirmed": true
    }
  ]
}                    
<GetGSMSiteAdminsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Admins>
    <GetGSMSiteAdminsResponseModel_Admin>
      <AccessLevel>128</AccessLevel>
      <Confirmed>true</Confirmed>
      <DisplayName>Test1 User1</DisplayName>
      <Email>test1@webroot.com</Email>
      <FirstName>Test1</FirstName>
      <LastName>User1</LastName>
      <MSPUser>false</MSPUser>
      <MobileTel>07365576</MobileTel>
      <OfficeTel>01824428</OfficeTel>
      <UserId>80d28ce6-225f-4f6c-91ce-4e28eda3dc57</UserId>
      <UserState>Activated</UserState>
    </GetGSMSiteAdminsResponseModel_Admin>
    <GetGSMSiteAdminsResponseModel_Admin>
      <AccessLevel>128</AccessLevel>
      <Confirmed>true</Confirmed>
      <DisplayName>Test2 User2</DisplayName>
      <Email>test2@webroot.com</Email>
      <FirstName>Test2</FirstName>
      <LastName>User2</LastName>
      <MSPUser>false</MSPUser>
      <MobileTel>07882988</MobileTel>
      <OfficeTel>01141762</OfficeTel>
      <UserId>1561f655-a4c0-421f-928b-91d60fa1c2e4</UserId>
      <UserState>Activated</UserState>
    </GetGSMSiteAdminsResponseModel_Admin>
  </Admins>
  <TotalCount>2</TotalCount>
</GetGSMSiteAdminsResponseModel>