Unity API Documentation

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/DBFD-AF71-C2BC-4591-9E14/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": "df1e241c-7885-4bc1-8742-020002a721f5",
      "Email": "test1@webroot.com",
      "FirstName": "Test1",
      "LastName": "User1",
      "DisplayName": "Test1 User1",
      "MobileTel": "07653917",
      "OfficeTel": "01365574",
      "UserState": "Activated",
      "AccessLevel": 128,
      "MSPUser": false,
      "Confirmed": true
    },
    {
      "UserId": "5912025f-95de-405c-884b-2c9631a1779d",
      "Email": "test2@webroot.com",
      "FirstName": "Test2",
      "LastName": "User2",
      "DisplayName": "Test2 User2",
      "MobileTel": "07194807",
      "OfficeTel": "01124813",
      "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>07653917</MobileTel>
      <OfficeTel>01365574</OfficeTel>
      <UserId>df1e241c-7885-4bc1-8742-020002a721f5</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>07194807</MobileTel>
      <OfficeTel>01124813</OfficeTel>
      <UserId>5912025f-95de-405c-884b-2c9631a1779d</UserId>
      <UserState>Activated</UserState>
    </GetGSMAdminsResponseModel_Admin>
  </Admins>
  <TotalCount>2</TotalCount>
</GetGSMAdminsResponseModel>