Forcepoint Management

the forcepoint management connector streamlines web security administration by automating category and access management through api interactions forcepoint management is a comprehensive web security solution that enables organizations to categorize and manage urls and ip addresses for enhanced policy enforcement and reporting the forcepoint management turbine connector allows users to seamlessly integrate these capabilities into swimlane turbine's low code automation platform by leveraging this connector, users can automate the categorization process, manage transactions, and retrieve category lists, thereby streamlining security operations and ensuring consistent policy application across the enterprise limitations none to date supported versions this forcepoint management connector uses the version 1 api additional docs api documentation https //help forcepoint com/websec/en us/on prem/85/mgmt api guide/a34f73c3 c213 4911 a924 a0110deda7e9 htmlauthentication https //help forcepoint com/websec/en us/on prem/85/mgmt api guide/93cf59f5 58f3 496a 9341 4010eb657469 html configuration prerequisites to effectively utilize the forcepoint management connector with turbine, ensure you have the following http basic authentication with these parameters url endpoint for the forcepoint management api username your forcepoint management account username password your forcepoint management account password http basic authentication with the following parameters url the endpoint url for the forcepoint management api username your forcepoint management account username password your forcepoint management account password capabilities this connector provides the following capabilities add categories commit transaction list all categories list api managed categrories rollback transaction start transaction add categories enables the addition of categories to organize urls and ip addresses within forcepoint management commit transaction records api managed categories, urls, ip addresses, and ranges in forcepoint management for policy enforcement and reporting the call is non blocking list all categories retrieve all categories, including forcepoint defined master database categories, available in the system list api managed categrories retrieves a list of all api managed categories available in forcepoint management rollback transaction cancels all add and delete commands within a specified transaction in forcepoint management start transaction initiates a transaction in forcepoint management for managing categories, urls, and ip addresses configurations http basic authentication authenticates using username and password configuration parameters parameter description type required url a url to the target host string required username username string required password password string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add categories enables the addition of categories to organize urls and ip addresses within forcepoint management endpoint url api/web/v1/categories method post input argument name type required description transaction id string optional the transaction id obtained in the start transaction call categories array optional parameter for add categories category name string optional the category name an error is returned if the category name is not unique category description string optional the category description parent number optional the id of the parent category 0 is the top level category, and can be specified as the parent output parameter type description status code number http status code of the response reason string response reason phrase categories array output field categories category name string name of the resource example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "categories" \[] } } ] commit transaction records api managed categories, urls, ip addresses, and ranges in forcepoint management for policy enforcement and reporting the call is non blocking endpoint url api/web/v1/categories/commit method post input argument name type required description transactionid string optional transaction id output parameter type description status code number http status code of the response reason string response reason phrase transaction id string unique identifier commit time string time value example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "transaction id" "a468af86 453a 11e6 88af a180af187bfd", "commit time" "april 8, 2016 11 37 am" } } ] list all categories retrieve all categories, including forcepoint defined master database categories, available in the system endpoint url api/web/v1/categories/all method get output parameter type description status code number http status code of the response reason string response reason phrase categories array output field categories category name string name of the resource category id number unique identifier category description string output field category description category hierarchy number output field category hierarchy category owner string output field category owner children array output field children category name string name of the resource category id number unique identifier category description string output field category description category hierarchy number output field category hierarchy category owner string output field category owner example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "categories" \[] } } ] list api managed categrories retrieves a list of all api managed categories available in forcepoint management endpoint url api/web/v1/categories method get input argument name type required description transactionid string optional lists all categories, including categories that have not yet been committed output parameter type description status code number http status code of the response reason string response reason phrase categories array output field categories category name string name of the resource category id number unique identifier category description string output field category description category hierarchy number output field category hierarchy category owner string output field category owner children array output field children category name string name of the resource category id number unique identifier category description string output field category description category hierarchy number output field category hierarchy category owner string output field category owner example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "categories" \[] } } ] rollback transaction cancels all add and delete commands within a specified transaction in forcepoint management endpoint url api/web/v1/categories/rollback method get input argument name type required description transactionid string optional transaction id output parameter type description status code number http status code of the response reason string response reason phrase transaction id string unique identifier rollback time string time value example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "transaction id" "a468af86 453a 11e6 88af a180af187bfd", "rollback time" "april 8, 2016 11 37 am" } } ] start transaction initiates a transaction in forcepoint management for managing categories, urls, and ip addresses endpoint url api/web/v1/categories/start method post output parameter type description status code number http status code of the response reason string response reason phrase transaction id string unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "transaction id" "44081c08 453a 11e6 a9de d99213c464e0" } } ]