Documentation

POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/admins

Adds a new user as a site admin to a site with the desired access level.

If the user does not have a Webroot account yet, a new user account is created and the user onboarding e-mail workflow is initiated to let the user set credentials and confirm the account. Whether or not a new Webroot account is created, the user will be added as an admin to the site and the first and last name on the user's account are set to the provided values.

NOTE: This API is for adding a new user as an admin to a site. To allow access to a site for a user who is already an admin on the GSM, use the set site admins API instead. To get a list of GSM-level admins, call the get GSM admins API.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The site identifier.	string	Required

URI Sample(s)

POST	https://unityapi.webrootcloudav.com/service/api/console/gsm/1B0D-FDB8-C655-4649-B825/sites/a52f0981-dcc4-4425-a1e7-460d431f0bff/admins

Body Parameters

Information about the user to add as admin and the desired access level.

CreateGSMSiteAdminRequestModel

Name	Description	Type	Additional Information
EmailAddress	Email address of the user to be added.	string	Required
FirstName	Value to be set as the user's first name. The name must be at least 2 characters and not more than 30 characters in length.	string	Required
LastName	Value to be set as the user's last name. The name must be at least 2 characters and not more than 30 characters in length.	string	Required
AccessLevel	The level of access to be granted to the user on the site. Valid values are 128 to grant administrative access, or 1 to grant limited/view access only.	integer	Required

Sample Request

{
  "EmailAddress": "jdoe@domain.com",
  "FirstName": "Jane",
  "LastName": "Doe",
  "AccessLevel": 128
}

<CreateGSMSiteAdminRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <AccessLevel>128</AccessLevel>
  <EmailAddress>jdoe@domain.com</EmailAddress>
  <FirstName>Jane</FirstName>
  <LastName>Doe</LastName>
</CreateGSMSiteAdminRequestModel>

Response Information

Resource Description

Information about the user which was added as a site admin to the site.

CreateGSMSiteAdminResponseModel

Name	Description	Type	Additional Information
UserId	The user identifier.	string	None.
Email	Email address of the user.	string	None.
FirstName	First name of the user.	string	None.
LastName	Last name of the user.	string	None.
DisplayName	Display name of the user.	string	None.
MobileTel	Mobile number of the user.	string	None.
OfficeTel	Office telephone number of the user.	string	None.
UserState	Indicates the user status. Valid values are "Activated", "Awaiting", "Confirmation", "Deactivated", "Removed", "Trial", "PreUber13User", "Unknown".	string	None.
AccessLevel	Indicates if user has view only or admin permission on this site. Valid values are 128 for admin access, 1 for view only access, 0 for no access.	integer	None.
MSPUser	Value (true/false) indicating if user is attached to the GSM Console (regardless of permissions).	boolean	None.
Confirmed	Value (true/false) indicating if user is confirmed.	boolean	None.

Sample Response

{
  "UserId": "bc04b85a-9af5-49fe-8cbd-3e0b838e99d7",
  "Email": "jdoe@domain.com",
  "FirstName": "Jane",
  "LastName": "Doe",
  "DisplayName": "Jane Doe",
  "MobileTel": "07200143",
  "OfficeTel": "01471076",
  "UserState": "Activated",
  "AccessLevel": 128,
  "MSPUser": false,
  "Confirmed": true
}

<CreateGSMSiteAdminResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <AccessLevel>128</AccessLevel>
  <Confirmed>true</Confirmed>
  <DisplayName>Jane Doe</DisplayName>
  <Email>jdoe@domain.com</Email>
  <FirstName>Jane</FirstName>
  <LastName>Doe</LastName>
  <MSPUser>false</MSPUser>
  <MobileTel>07200143</MobileTel>
  <OfficeTel>01471076</OfficeTel>
  <UserId>bc04b85a-9af5-49fe-8cbd-3e0b838e99d7</UserId>
  <UserState>Activated</UserState>
</CreateGSMSiteAdminResponseModel>