POST /service/api/console/gsm/{gsmKey}/admins
Adds a new user as an admin to a GSM console 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 GSM and the first and last name on the user's account are set to the provided values.
By default the added user will not have access to any sites under the GSM. Once added, use the set site admins API to grant access to individual sites as needed.
If the user had already been added as a site-only admin on specific sites before, the user's access to these sites remains unchanged.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
URI Sample(s)
|
POST
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/202F-6395-C550-44E3-9E43/admins
|
Body Parameters
Information about the user to add as admin and the desired access level.
CreateGSMAdminRequestModel| 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 GSM console. 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
}
<CreateGSMAdminRequestModel 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> </CreateGSMAdminRequestModel>
Response Information
Resource Description
Information about the user which was added as an admin to the GSM console.
CreateGSMAdminResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| UserId |
The user identifier. |
string |
None. |
|
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": "b937df20-09aa-40c4-bbdd-ec2830be3796",
"Email": "jdoe@domain.com",
"FirstName": "Jane",
"LastName": "Doe",
"DisplayName": "Jane Doe",
"MobileTel": "07715656",
"OfficeTel": "01704385",
"UserState": "Activated",
"AccessLevel": 128,
"MSPUser": false,
"Confirmed": true
}
<CreateGSMAdminResponseModel 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>07715656</MobileTel> <OfficeTel>01704385</OfficeTel> <UserId>b937df20-09aa-40c4-bbdd-ec2830be3796</UserId> <UserState>Activated</UserState> </CreateGSMAdminResponseModel>