Skip to content

Latest commit

 

History

History
187 lines (161 loc) · 61.1 KB

File metadata and controls

187 lines (161 loc) · 61.1 KB

Webroot integration

{% hint style="info" %} If you’re new to integrations in Rewst, read through our introductory integration documentation here. {% endhint %}

What does the Webroot integration do?

Our Webroot integration enables automation of endpoint and license management. Use the Webroot Unity API within Rewst workflows to manage sites, users, policies, endpoints, GSM console access and more.

Why use the Webroot integration?

  • Direct management of antivirus functions within Rewst for operational efficiency
  • Enhanced security monitoring capabilities integrated into daily workflows
  • Automated reporting and alerts based on antivirus activities and findings

Set up the Webroot integration

Set up steps in Webroot

  1. Navigate to Settings > Unity API Access.

  1. Click on New.
  2. Enter the Name and Description.

  1. Describe how you will use the Unity API

  1. Enter any suggestions or feedback you might have regarding the Unity API.
  2. Click Save.

Set up steps in Rewst

  1. Navigate to Configuration > Integrations in the left side menu of your Rewst platform.

  2. In the Integrations page, search for the Webroot integration.

    \

  3. Click on the integration tile to launch the Configuration setup page.

  4. Under Configuration:

    1. Edit the Name.
    2. Add an optional Description for your configuration.
    3. Check off Is Default.
  5. Under Parameters:

    1. Enter your Cove username in the Client ID field.
    2. Enter your client secret in the Client Secret field.
    3. Enter the parent key code in the Parent Key Code field.
    4. Enter the password of the user from your Webroot account into the Password field.
    5. Enter the username of the user from your Webroot account into the Username field.
  6. Click Save Configuration.

{% hint style="info" %} Got an idea for a new Integration? Rewst is constantly adding new integrations to our integrations page. Submit your idea or upvote existing ideas here in our Canny feedback collector. {% endhint %}

Webroot integration actions and endpoints

{% hint style="info" %} For more on how actions work in Rewst, check out our introductory actions documentation here. {% endhint %}

Webroot’s up-to-date API documentation can be found on their own website here.

Category Action Description
Console Access Request Admin Access to GSM Console Initiates the process for requesting admin access to a GSM console. Before initiating, it's the requester's responsibility to inform the owner of the target GSM console that a designated person will receive a confirmation message from Webroot.
Get GSM Add Admin Access Request Status Retrieves the status of a GSM add admin access request.
Console Gsm Get GSM Console Information Required Scope Console.GSM Gets information about a given GSM console.
Get GSM Console Information by Site Keycode Scope Console.GSM Looks up information about a specific GSM site associated with a given site keycode. You can use this method to query site details using a site keycode and retrieve the site's identifier for follow-up calls.
Get Web Console URL to Corresponding GSM Console 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.
Get Web Console URL to Corresponding Endpoint Protection Console 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.
List Sites Associated With A Given Gsm Console. Gets the list of sites associated with a given GSM console.
Get GSM Site Information Gets information about a GSM site.
Create New Site Under A Given Gsm Console. Creates a New Site Under A Given Gsm Console.
Update Site Under A Given Gsm Console.
Deactivate A Site Under A Given Gsm Console. Deactivates a site under a given GSM console.
Suspends A Site Under A Given Gsm Console. When a site is suspended the associated license key is forcibly expired.
Resumes A Site Under A Given Gsm Console. When a site is resumed, the site's license key inherits the days remaining of the parent GSM console keycode.
Converts A Trial Site Into A Full License. This operation will fail if the parent GSM console license is not a full license.
List Admins On A Given Gsm Console. Gets the list of admins on a given GSM console.
Add New User as Admin to GSM Console Adds a new user as an admin to a GSM console with the desired access level.
Get GSM Admin Information. Gets information about a GSM admin.
Update User Account Attributes Of A GSM Admin.
Removes GSM Admin From A Gsm Console And All Its Sites.
List Admins On GSM Site.
Gets Site Admin Information Gets information about a site admin.
Adds New User As A Site Admin To A Site With The Desired Access Level. Adds a new user as a site admin to a site with the desired access level.
Adds Admins To A Site Or Modifies Access Permissions Of Site Admins. Adds admins to a site or modifies access permissions of site admins. Depending on the number of permission changes, these modifications may take a few minutes to be processed and visible to other API calls.
Update Certain User Account Attributes Of A Site Admin Edits certain user account attributes of a site admin.
Remove Admin From A Site Admin will be removed from the site. If the admin is also an admin on the parent GSM console, that user's access level for this site only becomes 0 (no access).
List Global Policies On A Given Gsm Console
Get Information About A Gsm Policy
List Policies On A Given GSM Site
Get Information About A Site Policy
List Groups On A Given GSM Site
Create Group Under GSM Site
Get Group Information
Update Group Under A Given GSM Site
Deletes Group Under A Given GSM Site
List Endpoints On A Given GSM Site
Move Endpoints To A Different Group.
Get Endpoint Information
List Endpoints On A Given Group
Apply New Policy To Specified Endpoints
Apply New Policy To Group Of Endpoints
Reactivate List Of Endpoints Or All Endpoints On A Site. This command is only applied to deactivated endpoints.
Deactivate List Of Endpoints, Or All Endpoints On A Site.
Deactivate All Endpoints In A Group
List Executed Commands On A Given GSM Site
List Executed Commands On A Given Group Only returns the executed commands from the past 6 months.
List Executed Commands On A Given Endpoint Only returns the executed commands from the past 6 months.
Issue An Agent Command To A List Of Endpoints, Or To All Endpoints On A Site.
Issue An Agent Command To A Group Of Endpoints
Get Threat History Information For Endpoints On A GSM Site NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 3 calendar months.
Get Threat History Information For Endpoints On A Group NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 3 calendar months.
Get Threat History Information For A Given Endpoint NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 3 calendar months.
Get Per Day Summary Counts Of Number Of Recorded Url Actions On Endpoints In The Given Site NOTE: Blocked URLs data is generally available up to 90 days in the past. However, the maximum allowed time range between 'startDate' and 'endDate' is 30 days.
List Recorded Url Actions On Endpoints In The Given Site NOTE: Blocked URLs data is generally available up to 90 days in the past. However, the maximum allowed time range between 'startDate' and 'endDate' is 30 days.
List Available DNS Protection Categories And Respective Identifiers
List Available DNS Protection Policies And Respective Identifiers For GSM Parent Keycode
Get Specified DNS Protection Policy Information
Get Defined Mappings Of DNS Protection Policies For A GSM Parent Keycode, Filtered By The Given Site.
Creates Mapping For DNS Protection Policy For GSM Site
Get Mapping Of DNS Protection Policy Information Returns detailed information for a specified mapping of a DNS Protection policy.
Update Specified Mapping Of A DNS Protection Policy
Delete Specified Mapping Of DNS Protection Policy
List Available DNS Protection Block Reasons And Respective Identifiers
Get Information About Dns Requests That Were Blocked By The Dns Protection Service. The maximum allowed time difference between 'startDate' and 'endDate' is 30 days. WARNING: The maximum number of returned traffic records is limited. For high-use sites, query more regularly for shorter periods rather than pulling data for 30 days at once.
Get DNS Request Information Seen by DNS Protection Services for One or More Specified Categories The maximum allowed time difference between 'startDate' and 'endDate' is 30 days. WARNING: The maximum number of returned traffic records is limited. For high-use sites, query more regularly for shorter periods.
Get Traffic Summary for Each Site Under Given GSM NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days. (E.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for each site under a given GSM.
Get Traffic Summary For Specific Site Under Given GSM Returns a traffic summary (e.g. total DNS requests, blocked DNS requests, and risky DNS requests) for a specific site under a given GSM. NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.
Get Traffic Summary Grouped By Categories For Given GSM Returns a traffic summary (e.g. total DNS requests, blocked DNS requests, allowed DNS requests) grouped by categories for a given GSM. NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.
Get Traffic Summary Grouped By Categories For Specific Site Under Given GSM Gets a traffic summary (e.g. total DNS requests, blocked DNS requests, allowed DNS requests) grouped by categories for a specific site under a given GSM. NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.
Get Traffic Summary Grouped By Categories And Users For Given Gsm. Returns a traffic summary (e.g. blocked DNS requests, allowed DNS requests, and user name) grouped by categories and users for a given GSM. NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.
Get Traffic Summary Grouped By Categories And Users For Specific Site Under Given GSM Gets a traffic summary (e.g. blocked DNS requests, allowed DNS requests, and user name) grouped by categories and users for a specific site. NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.
Get Activity Overview for Webroot Security Awareness Training (WSAT) Phishing Campaigns on a Specific Site Get information on activity for WSAT phishing campaigns associated with a given site. startDate cannot be earlier than one year ago, and the timespan between startDate and endDate must not exceed 90 days.
Get Activity Overview for Webroot Security Awareness Training (WSAT) Campaigns for a Specific Site Get information on activity for WSAT training campaigns associated with a given site. startDate cannot be earlier than one year ago, and the timespan between startDate and endDate must not exceed 90 days.
Ecom Create New Shopping Cart Creates a new shopping cart. Carts act as a container for pending orders.
Get Cart by VendorOrderCode Gets a cart by its vendorOrderCode. The response also includes the cart's items and customers, if present.
Create End/Reseller Customer Creates end-customer (shipping) and/or reseller-customer records for a cart. Note a billing customer is associated when the cart is created and cannot be changed.
Get Customers Gets the customers associated with a cart.
Create Order by Processing Cart Create Order by Processing Cart
Get Order Status Info Gets information about the order status for a keycode.
Cancel Product Creates a request to cancel a particular product.
Get License by Keycode Get License by Keycode
Get Child Licenses Gets all child licenses of a parent license, but without billing information, which is maintained by the parent license.
Create Trial License Creates a trial license for a given product.
Create Trial Modules Creates a trial module for a given parent keycode.
Generic Request Webroot API Request Generic action for making authenticated requests against the Webroot API.
Get Health Ping Empty action that can be used to ping for the availability of the service.
Get Health Version Retrieves version information of the running service environment.
Notifications List Available Event Types and Subscription Details with Required Permissions Gets a list of available event types that can be subscribed to, with info on required scope permissions and subscription domains for each event type.
Get Active Subscriptions Information With The Authenticated Caller. Subscriptions are maintained by username and client ID. Only subscriptions created and active for the current username/client ID pair are returned.
Create New Subscription Please refer to https://unityapi.webrootcloudav.com/Docs/en/APIDoc/Api/POST-api-notifications-subscriptions
Get Specific Subscription Information
Update Specific Subscription Information For webhook-based subscriptions: When changing DeliveryContext or DeliveryUrl, a validation call is made. The webhook must respond with the correct ValidationResponse matching ValidationContext. RE - Notifications Guide.
Unsubscribe From A Specific Subscription Unsubscribing from a subscription means no more notifications will be made available under this subscription.
Get Latest Notifications For A Specific Subscription Returns notifications for a subscription in chronological order, up to 1000 per call. Use NextPosition from the previous response for subsequent calls. The response indicates if more notifications remain.
Create A Position Token To Start Fetching Notifications Generates a position token to start fetching notifications.
Suspends Calls To The Subscription's Webhook Delivery URL Suspends calls to the subscription's webhook DeliveryUrl for informing about new notifications.
Resumes Calls To The Subscription's Webhook Delivery URL Resumes calls to the subscription's webhook DeliveryUrl for informing about new notifications.
Skystatus Get Agent Status for Endpoints - GSM Required Scope - SkyStatus.GSM. Returns agent status information for all endpoints matching the specified criteria.
Get DNS Protection Status for Endpoints - GSM Required Scope - SkyStatus.GSM. Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.
Get DNS Protection Status for Endpoints - Site Required Scope - SkyStatus.Site. Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.
Get Site-level Summary Report of Endpoint Usage Required Scope SkyStatus.Reporting - Returns a site-level summary report of endpoint usage for a GSM master keycode. For each site, the report includes the site name, license type, and total endpoints.
Get GSM-level summary Report of Endpoint Usage Required Scope SkyStatus.Reporting - Returns a GSM-level summary report of endpoint usage for a GSM master keycode. Besides general info like the console name and GSM license type, the report includes the total number of sites and endpoints.
Get Site-level Summary Report of Endpoint Usage by Site Keycode Required Scope SkyStatus.Reporting - Returns a site-level summary report of endpoint usage for a GSM master keycode by site keycode. The report includes info like the site name, license type, and total endpoints.
Get Endpoint-level Summary Report of Endpoint Usage Required Scope SkyStatus.Reporting - Returns an endpoint-level summary report of endpoint usage for a GSM master keycode. For each endpoint, the report includes info like the hostname, machine identifier, and activation state.
Get Endpoint-level Summary Report of Endpoint Usage by Site Keycode Scope SkyStatus.Reporting - Returns an endpoint-level summary report of endpoint usage for a GSM master keycode by a site keycode. For each endpoint, the report includes info like the hostname, machine identifier, and activation state.
Get GSM-level Summary Report of DNSP Usage Required Scope SkyStatus.Reporting - Returns a GSM-level summary report of DNSP usage for a GSM master keycode. Besides general info like the console name and GSM license type, the report includes total sites and devices.
Get Site-level Summary Report of DNSP Usage Required Scope SkyStatus.Reporting - Returns a site-level summary report of DNSP usage for a GSM master keycode. For each site, the report includes info like the site name, license type, and total devices.
Get Site-level Summary Report of DNSP Usage by Site Keycode Required Scope SkyStatus.Reporting - Returns a site-level summary report of DNSP usage for a GSM master keycode by a site keycode. The report includes info like the site name, license type, and total devices.
Get GSM-level Summary Report of WSAT Usage Required Scope SkyStatus.Reporting - Returns a GSM-level summary report of WSAT usage for a GSM master keycode. Besides general info like the console name and GSM license type, the report includes the total number of sites and users.
Get Site-level Summary Report of WSAT Usage Required Scope SkyStatus.Reporting - Returns a site-level summary report of WSAT usage for a GSM master keycode. For each site, the report includes info like the site name, license type, and total users.
Get Site-level Summary Report of WSAT Usage by Site Keycode Required Scope SkyStatus.Reporting - Returns a site-level summary report of WSAT usage for a GSM master keycode by a site keycode. The report includes info like the site name, license type, and total users.