extract_configuration_param
Related Concepts: Integration Configuration & Script Parameters
Get the value of an integration configuration parameter. Each integration has parameters that are part of its configuration (configured in the marketplace). This method allows extracting the value of a selected parameter from the integration’s currently saved configurations.
param_value= siemplify.extract_configuration_param(
provider_name,
param_name,
default_value=None,
input_type=str,
is_mandatory=False,
print_value=False)
Parameters:
Param Name | Param Type | Possible Values | Comments | Mandatory Parameter |
---|---|---|---|---|
provider_name | string | Any of the integration names in the marketplace | The name of the integration to get the parameter from its configuration | Yes |
param_name | string | Any of the parameters names available in the integration’s configuration | The name of the parameter to fetch | Yes |
default_value |
|
Any desired value | The default value of the parameter. The given value will be returned if the parameter was not set (if is_mandatory is set to False). Defaults to None. | No |
input_type |
|
Any valid python type | The type of the parameter. The returned value will be cast to the selected input type. Defaults to str. | No |
is_mandatory | boolean | True/False | Whether the parameter is mandatory. If set to True and the parameter was not filled, an exception will be raised. Default to False. | No |
print_value | boolean | True/False | Whether to output the fetched value of the parameter to the logs. Default to False. | No |
Return Type
As passed in input_type
Sample Code
from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
param_value= siemplify.extract_configuration_param(
"VirusTotal",
"Api Key",
default_value=None,
input_type=str,
is_mandatory=True,
print_value=False)
Result Behavior
The value of the selected parameter will be returned, casted to selected type.
Result Value
123456