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.
Request Information
URI Parameters
Name | Description | Type | Additional 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/A723-6294-8915-4E77-8C37/sites/547350aa-a23b-48c6-a99c-49eacf3e806a/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.
GetGSMSiteSSOTokenResponseModelName | Description | Type | Additional 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": "EB1D-BC57-B4F8-494B-8BF0", "SiteId": "b9bee306-346d-4d66-98ba-1eb96ebda04e", "AccountKeyCode": "7D0B-7904-532F-40FF-A22D", "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>7D0B-7904-532F-40FF-A22D</AccountKeyCode> <GSMKeyCode>EB1D-BC57-B4F8-494B-8BF0</GSMKeyCode> <SiteId>b9bee306-346d-4d66-98ba-1eb96ebda04e</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>