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

Gets the list of admins on a given GSM console.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/97F8-09D2-CEDE-4515-9C3E/admins

Body Parameters

None.

Response Information

Resource Description

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

GetGSMAdminsResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of users available.

integer

None.

Admins

List of user details records.

Collection of GetGSMAdminsResponseModel_Admin

None.

Sample Response

{
  "TotalCount": 2,
  "Admins": [
    {
      "UserId": "c7291cab-a8d2-4d00-8dd1-9df887426d1e",
      "Email": "test1@webroot.com",
      "FirstName": "Test1",
      "LastName": "User1",
      "DisplayName": "Test1 User1",
      "MobileTel": "07570994",
      "OfficeTel": "01492056",
      "UserState": "Activated",
      "AccessLevel": 128,
      "MSPUser": false,
      "Confirmed": true
    },
    {
      "UserId": "65d4b1cf-ac17-4c2b-a175-7cf5c1147f6c",
      "Email": "test2@webroot.com",
      "FirstName": "Test2",
      "LastName": "User2",
      "DisplayName": "Test2 User2",
      "MobileTel": "07178252",
      "OfficeTel": "01781553",
      "UserState": "Activated",
      "AccessLevel": 128,
      "MSPUser": false,
      "Confirmed": true
    }
  ]
}                    
<GetGSMAdminsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Admins>
    <GetGSMAdminsResponseModel_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>07570994</MobileTel>
      <OfficeTel>01492056</OfficeTel>
      <UserId>c7291cab-a8d2-4d00-8dd1-9df887426d1e</UserId>
      <UserState>Activated</UserState>
    </GetGSMAdminsResponseModel_Admin>
    <GetGSMAdminsResponseModel_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>07178252</MobileTel>
      <OfficeTel>01781553</OfficeTel>
      <UserId>65d4b1cf-ac17-4c2b-a175-7cf5c1147f6c</UserId>
      <UserState>Activated</UserState>
    </GetGSMAdminsResponseModel_Admin>
  </Admins>
  <TotalCount>2</TotalCount>
</GetGSMAdminsResponseModel>