Symantec Cloud Secure Web Gateway

symantec cloud secure web gateway is a cloud based security solution that protects against web threats and enforces internet usage policies symantec cloud secure web gateway is a comprehensive security solution that provides advanced threat protection and policy management for web traffic this connector allows swimlane turbine users to automate the management of policy lists, including creating, retrieving, updating, and deleting custom policy lists by integrating with symantec cloud secure web gateway, users can streamline policy enforcement, enhance security posture, and ensure compliance with organizational policies, all within the swimlane turbine platform limitations api credentials are only visible when first created in the cloud swg portal; store them securely they cannot be edited or re displayed later each api key must be granted the correct access roles in the portal (for example, policy management) using credentials against an api whose role was not selected returns 403 forbidden with an invalid credentials style message rate limits apply per the policy management api many methods are limited to 6 requests per minute (refilled on 60 second intervals) the publish operation has a stricter default limit ( 1 request per 15 minutes ) endpoints and behavior follow broadcom’s published api reference; regional or tenant specific base urls may differ from the default portal host supported version this connector targets the policy management rest api as documented in broadcom tech docs (swagger info version 1 0 in the policy reference) authentication uses http basic with the api username and password pair generated under account configuration → api credentials in the cloud swg portal configuration prerequisites before you can use the symantec cloud secure web gateway connector for turbine, you'll need access to the symantec cloud swg api this requires the following http basic authentication using cloud swg api username and password from account configuration, api credentials url the endpoint for accessing the symantec cloud swg api api username your account's api username for authentication api password your account's api password for authentication authentication methods http basic (api username and password) cloud swg apis authenticate with the api username as the basic auth username and the api password as the basic auth password—the same pattern as curl u "\<api username> \<api password>" x get "https //portal threatpulse com/api/rest/policy/listtypes" setup instructions sign in to the cloud swg portal open account configuration → api credentials click add api credentials and copy the generated username and password immediately set expiry (time based or never) and assign access roles that include policy management for list and publish operations in the turbine asset, set url to your rest base (default https //portal threatpulse com/api/rest , no trailing slash after rest ), then paste api username and api password document references api authentication (api keys) https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api keys htmlcloud swg api reference (overview) https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference htmlpolicy management api reference https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html troubleshooting tips 403 forbidden / invalid credentials confirm the api key’s access roles include the api family you are calling, and that the username and password match the pair saved at creation time 404 on list type or list verify the list type or list id exists for the tenant and that the path is correct relative to the configured url (policy paths should not repeat /api/rest in individual actions if the asset url already ends with /api/rest ) capabilities this connector provides comprehensive integration with the cloud swg policy management api, supporting full crud and operational management of custom policy lists, list types, and publish operations get policy list types list policy lists create policy list get policy list by id replace policy list contents append policy list items delete policy list publish policy list policy object catalog get policy list items by type (paged) get policy list types returns the available custom policy list types that the customer can create or modify this is useful for building ui dropdowns or validating input for list related operations api reference get policy list types https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#get listtypes list policy lists lists all existing custom policy lists for the customer you can filter results by type via query parameter useful to inventory current policy structures or identify lists for further action api reference list policy lists https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#get lists create policy list creates a new custom policy list of a specified type input fields must include name , type , and may include an initial set of items and a comment api reference create policy list https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#post lists get policy list by id returns metadata and the current item set for a specific policy list use this to review or modify existing lists api reference get policy list by id https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#get listslistid replace policy list contents completely replaces the items in an existing policy list using a put operation required fields include name , type , items , and optionally a comment api reference replace policy list contents https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#put listslistid append policy list items adds one or more items to an existing policy list with a patch operation this appends entries to the list without overwriting existing data api reference append policy list items https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#patch listslistid delete policy list deletes a custom policy list by id if it is no longer referenced by any active rule or policy api reference delete policy list https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#delete listslistid publish policy initiates the publish operation for the customer's current policy configuration note the publish endpoint is rate limited to one call per 15 minutes ensure prior changes have settled before invoking this operation api reference publish policy https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#put policypublish list policy object catalog / items by type retrieves a paginated list of available policy objects by their type—used when assembling, validating, or reviewing list membership supports type , page , and size query parameters for fine grained control api reference list policy object catalog https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html#get listitemscatalogtype for additional detail on each endpoint and request schema, refer to the policy management api reference https //techdocs broadcom com/us/en/symantec security software/web and network security/cloud swg/help/cloudswg api reference/api reference plm html asset setup configure the http basic asset with url — rest base url (default https //portal threatpulse com/api/rest ) api username / api password — from api credentials in the cloud swg portal verify ssl certificates and http(s) proxy — optional, per your environment test connectivity with a read only action such as get policy list types before running mutating or publish operations notes individual action names and input fields match the yaml definitions under connector/config/actions/ for policy list usage examples beyond the rest reference, see broadcom’s related topics linked from the policy management documentation (for example, policy list usage guides where published) configurations http basic authentication http basic authentication using cloud swg api username and password from account configuration, api credentials configuration parameters parameter description type required url cloud swg rest api base url string required username api credential username shown when the key was created string required password api credential password shown when the key was created string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions append policy list items appends entries to an existing published customer policy list in symantec cloud secure web gateway requires the policy list id as a path parameter endpoint url policy/lists/{{id}} method patch input argument name type required description path parameters id string required unique identifier of the custom policy list to update name string optional list display name as stored in policy management type string optional policy list type identifier for this list resource comment string optional optional comment describing list purpose or change reason items array optional new list entries to append without removing existing items items id number optional numeric identifier for an existing list item if applicable items name string optional value or name text stored for this list entry items comment string optional optional per item comment for administrators input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"},"name" "example name","type" "string","comment" "string","items" \[{"id" 123,"name" "example name","comment" "string"}]} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example {} create policy list create a new empty custom policy list for the customer account in symantec cloud secure web gateway requires json body with name and type endpoint url policy/lists method post input argument name type required description name string optional display name for the new custom policy list type string optional policy list type identifier from available list types comment string optional optional administrator comment describing list purpose input example {"name" "example name","type" "string","comment" "string"} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase name string name of the resource id string unique identifier type string type of the resource output example {"name" "example name","id" "12345678 1234 1234 1234 123456789abc","type" "string"} delete policy list delete an unreferenced published custom list for the customer in symantec cloud secure web gateway using the specified id endpoint url policy/lists/{{id}} method delete input argument name type required description path parameters id string required unique identifier of the custom policy list to delete input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"}} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example {} get policy list by id retrieve a custom policy list and all its items from symantec cloud secure web gateway using the specified id as a path parameter endpoint url policy/lists/{{id}} method get input argument name type required description path parameters id string required unique identifier of the custom policy list to retrieve input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"}} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase name string name of the policy list type string type of the policy list comment string optional comment for the policy list items array list of items contained in the policy list items id number unique identifier for the item items name string name of the item items comment string optional comment for the item output example {"name" "example name","type" "string","comment" "string","items" \[{"id" 123,"name" "example name","comment" "string"}]} get policy list types retrieve custom policy list types that can be created or modified in symantec cloud secure web gateway endpoint url policy/listtypes method get output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example \[] get policy lists retrieve customer policy lists from symantec cloud secure web gateway, optionally filtered by list type endpoint url policy/lists method get input argument name type required description parameters type string optional when set, returns only lists matching this policy list type input example {"parameters" {"type" "string"}} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example \[] get policy object items by type retrieve paged policy objects by type for custom lists, sorted by name requires 'type' as a path parameter endpoint url policy/items/{{type}} method get input argument name type required description path parameters type string required policy object type key identifying which catalog to retrieve parameters page number optional zero based page index for paged policy object results parameters size number optional maximum number of objects returned per page request input example {"path parameters" {"type" "string"},"parameters" {"page" 123,"size" 20}} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example \[] publish policy publish the customer policy in symantec cloud secure web gateway with a default api limit of one call per fifteen minutes endpoint url policy/publish method put output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example {} replace policy list items replace the entire contents of an existing published customer policy list in symantec cloud secure web gateway requires the 'id' as a path parameter endpoint url policy/lists/{{id}} method put input argument name type required description path parameters id string required unique identifier of the custom policy list to replace name string optional list display name as stored in policy management type string optional policy list type identifier for this list resource comment string optional optional comment describing list purpose or change reason items array optional complete set of list entries after replacement operation items id number optional numeric identifier for an existing list item if applicable items name string optional value or name text stored for this list entry items comment string optional optional per item comment for administrators input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"},"name" "example name","type" "string","comment" "string","items" \[{"id" 123,"name" "example name","comment" "string"}]} output parameter type description status code number http status code of the response headers object http headers for the request reason string response reason phrase output example {} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt