Unity API Documentation

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

Gets information about a site admin.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required
siteId

The site identifier.

 string

Required
userId

The admin identifier to query information for.

 string

Required

Body Parameters

None.

Response Information

Resource Description

Information about the desired site admin.

GetGSMSiteAdminsResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of users available.

 integer

None.
Admins

List of policy details records.

 Collection of GetGSMSiteAdminsResponseModel_Admin

None.

Sample Response

{
  "TotalCount": 1,
  "Admins": [
    {
      "UserId": "5fa83988-6174-4cbf-bb20-ff3ffcb21f2a",
      "Email": "test1@webroot.com",
      "FirstName": "Test1",
      "LastName": "User1",
      "DisplayName": "Test1 User1",
      "MobileTel": "07996359",
      "OfficeTel": "01982663",
      "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>07996359</MobileTel>
      <OfficeTel>01982663</OfficeTel>
      <UserId>5fa83988-6174-4cbf-bb20-ff3ffcb21f2a</UserId>
      <UserState>Activated</UserState>
    </GetGSMSiteAdminsResponseModel_Admin>
  </Admins>
  <TotalCount>1</TotalCount>
</GetGSMSiteAdminsResponseModel>