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/5765-C27A-51ED-498A-BD56/sites/7f92f0ad-a847-4102-9979-4ece06b0a7fd/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": "5525eed9-0682-44e4-8a09-f03adf375b98",
      "Email": "test1@webroot.com",
      "FirstName": "Test1",
      "LastName": "User1",
      "DisplayName": "Test1 User1",
      "MobileTel": "07591717",
      "OfficeTel": "01932736",
      "UserState": "Activated",
      "AccessLevel": 128,
      "MSPUser": false,
      "Confirmed": true
    },
    {
      "UserId": "6a3b6071-4e06-481e-bbd9-f4fbffa93c0a",
      "Email": "test2@webroot.com",
      "FirstName": "Test2",
      "LastName": "User2",
      "DisplayName": "Test2 User2",
      "MobileTel": "07666121",
      "OfficeTel": "01598253",
      "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>07591717</MobileTel>
      <OfficeTel>01932736</OfficeTel>
      <UserId>5525eed9-0682-44e4-8a09-f03adf375b98</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>07666121</MobileTel>
      <OfficeTel>01598253</OfficeTel>
      <UserId>6a3b6071-4e06-481e-bbd9-f4fbffa93c0a</UserId>
      <UserState>Activated</UserState>
    </GetGSMSiteAdminsResponseModel_Admin>
  </Admins>
  <TotalCount>2</TotalCount>
</GetGSMSiteAdminsResponseModel>