Unity API Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/webconsoleurl

Gets a URL to the Webroot web console that, when used in a browser, automatically logs the authenticated user in to the corresponding Endpoint Protection Console.

The lifetime of the returned console URL is 5 minutes.

IMPORTANT: Due to 2-factor authentication requirements for the Webroot Console, as of Dec 2019 the Unity API SSO feature will be temporarily changed, where users will be directed to the usual Webroot Console Username/Password screen to re-authenticate. We will issue further notices when the SSO feature is redesigned.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM keycode the site is under.

 string

Required
siteId

The identifier of the GSM site the user wants to access using the web console.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/51AF-9120-F43D-4BCF-9E94/sites/5c3ea518-3eb8-435e-b665-5ab5f45fd9ce/webconsoleurl

Body Parameters

None.

Response Information

Resource Description

Information about a single sign-on URL to the Endpoint Protection Console for the desired GSM site.

GetGSMSiteSSOTokenResponseModel
NameDescriptionTypeAdditional Information
GSMKeyCode

The GSM parent keycode.

 string

None.
SiteId

The site identifier of the GSM site the single sign-on URL is valid for.

 string

None.
AccountKeyCode

The keycode of the GSM site the single sign-on URL is valid for.

 string

None.
SiteName

The site name.

 string

None.
UserName

The name of the authenticated user that will be logged in to the console when using the single sign-on URL.

 string

None.
WebConsoleURL

Direct URL to the Endpoint Protection Console.

 string

None.

Sample Response

{
  "GSMKeyCode": "265B-4B9F-E860-43B3-A8CE",
  "SiteId": "81075a00-ad5f-4328-ad57-61bf771caedc",
  "AccountKeyCode": "1C49-522F-55EB-4EB2-B11F",
  "SiteName": "Site Name",
  "UserName": "john.doe@mydomain.com",
  "WebConsoleURL": "https://my.webrootanywhere.com/sso.aspx?kk=5450646b-b262-11e7-acc6-06b9f74b769e"
}                    
<GetGSMSiteSSOTokenResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <AccountKeyCode>1C49-522F-55EB-4EB2-B11F</AccountKeyCode>
  <GSMKeyCode>265B-4B9F-E860-43B3-A8CE</GSMKeyCode>
  <SiteId>81075a00-ad5f-4328-ad57-61bf771caedc</SiteId>
  <SiteName>Site Name</SiteName>
  <UserName>john.doe@mydomain.com</UserName>
  <WebConsoleURL>https://my.webrootanywhere.com/sso.aspx?kk=5450646b-b262-11e7-acc6-06b9f74b769e</WebConsoleURL>
</GetGSMSiteSSOTokenResponseModel>