Related Concepts: Integration Configuration & Script Parameters

This function retrieves the stored configurations of the integration for the current running action. The only mandatory parameter is the “Integration Provider”, which is essentially the integration’s name. This identifier is the same string used in the integration’s definition file. The output of the function is a dictionary with all the properties found in the store’s database that matches the integration’s provider name. For example, if you want to write an action for “Active Directory”, you need to use the following code:

conf = siemplify.get_configuration("ActiveDirectory")

Parameters:

Param Name Param Type Possible Values Comments Mandatory Parameter
provider string Any one of the integration names from the marketplace Integration Provider name is case sensitive. An error will be thrown if the integration is not installed or the string does not exist Yes
environment string Environment name from the settings Optional If provided, the credentials will be taken from the relevant environment’s configuration. If no environment is stated, the case’s environment is used by default. If there is no configuration for that specific environment, the default configuration will be returned No

Return Type

Dictionary

Example:

Sample Code
from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()

conf = siemplify.get_configuration("ActiveDirectory")

username = conf["Username"]
Result Behavior
Fetches relevant active directory configuration and returns it as a dictionary.
Result Value
{"Server": "Server Address", "Username": "Username", "Password": "Password", "Domain": "Domain", "Custom Fields": "Custom Fields", "Use SSL": "true"}