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

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

The lifetime of the returned console URL is 5 minutes.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM keycode the user wants to access using the web console.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about a single sign-on URL to the desired GSM console.

GetGSMSSOTokenResponseModel
NameDescriptionTypeAdditional Information
GSMKeyCode

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

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 GSM console.

string

None.

Sample Response

{
  "GSMKeyCode": "5FA2-57E5-75BF-4883-A813",
  "UserName": "john.doe@mydomain.com",
  "WebConsoleURL": "https://my.webrootanywhere.com/sso.aspx?kk=5450646b-b262-11e7-acc6-06b9f74b769e"
}                    
<GetGSMSSOTokenResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <GSMKeyCode>5FA2-57E5-75BF-4883-A813</GSMKeyCode>
  <UserName>john.doe@mydomain.com</UserName>
  <WebConsoleURL>https://my.webrootanywhere.com/sso.aspx?kk=5450646b-b262-11e7-acc6-06b9f74b769e</WebConsoleURL>
</GetGSMSSOTokenResponseModel>