HTTP

the http connector facilitates interaction with web services and apis by enabling the construction and dispatch of custom http requests the http connector enables seamless integration with web services and apis, allowing users to automate http requests within their security workflows by leveraging this connector, swimlane turbine users can build and send custom http requests to specified endpoints, facilitating flexible web interactions this integration empowers security teams to automate web service interactions, enhancing the efficiency and effectiveness of their security operations prerequisites before you can use the http connector for turbine, you'll need to configure authentication mechanisms based on your requirements this includes bearer token authentication using the following parameters url the endpoint url for the http request token the bearer token used for authentication basic authentication using the following parameters url the endpoint url for the http request username the username for basic authentication password the password associated with the username api key authentication using the following parameters url the endpoint url for the http request api key the key used to authenticate the request api key name the name of the api key parameter api key location the location where the api key should be included (e g , header, query) oauth 2 0 client credentials using the following parameters url the endpoint url for the http request client id the client identifier issued by the authorization server and so on capabilities this connector provides the following capabilities send an http request limitations this connector works for any api that conforms to a standard authentication scheme any api that has implemented its own custom method is not supported by this connector asset setup please read the api documentation of the product you would like to connect to swimlane in order to understand which authentication type is required this connector supports the following authentication types no auth, basic, bearer token, api key/token oauth2 0 client credentials configuring an asset host ( required ) = the hostname of the product's api authentication type ( required ) = type of authentication to use for this api options no auth , basic , bearer , api key , oauth2 client credentials verify ssl = toggle ssl verification support http proxy = a proxy url where all requests can get routed through no auth authentication not recommended and most likely not supported by your api nothing is required to authenticate basic authentication this means you have select authentication type to be basic basic username ( required ) = the api username basic password ( required ) = the api password, sometimes this is an api token bearer token authentication this means you have select authentication type to be bearer bearer token ( required ) = the bearer token for the api api key authentication this means you have select authentication type to be api key api key name ( required ) = the api key name api key value ( required ) = value of the api key api key location ( required ) = location of the api key name and value options query params or headers oauth2 0 client credentials authentication this means you have select authentication type to be oauth2 client credentials oauth2 client id ( required ) = client id oauth2 client secret ( required ) = client secret oauth2 token url ( required ) = the full url, including host, of where to get the access token oauth2 scope ( required ) = space separated string of scopes to apply to the access token actions setup after configuring an asset for the api you can create as many generic http request actions as you would like endpoint ( required ) = the endpoint of the api to send a request to this includes everything that comes after the host except for query parameters method ( required ) = http request method and typically one of get , post , patch , delete , put when provided, the following inputs must be valid json strings for creating dynamic strings please use the new string interpolation feature documentation can be found here input configuration string interpolation https //swimlane com/knowledge center/docs/administrator guide/integrations/configure task input#map script or api input field parameters query parameters = optional url query parameters to send with the request headers = optional headers to send with the request request body = request payload as json configurations api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required apikey api key value string required apikey name the header key name for which to apply the api key string required apikey in the location of the api key options header, cookie or query string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional headers additional headers to send with each request such as a user agent object optional ca cert a base64 encoded ca certificate to use for ssl verification string optional 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 headers additional headers to send with each request such as a user agent object optional ca cert a base64 encoded ca certificate to use for ssl verification string optional http bearer authentication authenticates using bearer token such as a jwt, etc configuration parameters parameter description type required url a url to the target host string required token the api key, token, etc string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional headers additional headers to send with each request such as a user agent object optional ca cert a base64 encoded ca certificate to use for ssl verification string optional oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required token url string required client id the client id string required client secret the client secret string required scope permission scopes for this action array optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional headers additional headers to send with each request such as a user agent object optional ca cert a base64 encoded ca certificate to use for ssl verification string optional actions send http request build and send a custom http request to specified endpoints for flexible web interactions input argument name type required description endpoint string optional path to the endpoint after url in asset use double brackets with path parameters for dynamic urls method string optional method of the request such as post, get, put, patch, delete (note, others are available to use) data body object optional body to send as data, this allows you to set the content type in the headers manually headers object optional request headers to send with the individual request input example {"endpoint" "api/v3/users"} output parameter type description status code number the http response status code data object the json response body response text string output field response text reason string the http reason, often times an error message can be here ok means success output example {"response text" "string"} 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