Unity API Documentation

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

Gets information about a GSM admin.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required
userId

Identifier of the admin to query information for.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/06E1-F506-1AF7-4924-A03F/admins/ef4e8994-4ebe-43b8-8c64-7bf3475f6e71

Body Parameters

None.

Response Information

Resource Description

Information about the desired admin.

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": 1,
  "Admins": [
    {
      "UserId": "0ffc1334-71e6-4e87-8bfa-e5c2ed4c91df",
      "Email": "test1@webroot.com",
      "FirstName": "Test1",
      "LastName": "User1",
      "DisplayName": "Test1 User1",
      "MobileTel": "07433093",
      "OfficeTel": "01576068",
      "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>07433093</MobileTel>
      <OfficeTel>01576068</OfficeTel>
      <UserId>0ffc1334-71e6-4e87-8bfa-e5c2ed4c91df</UserId>
      <UserState>Activated</UserState>
    </GetGSMAdminsResponseModel_Admin>
  </Admins>
  <TotalCount>1</TotalCount>
</GetGSMAdminsResponseModel>