TIPCommon 2.1.0
The TIPCommon 2.1.0 library contains the following modules:
TIPCommon.adapters
TIPCommon.base
parse_case_attachment()
parse_case_comment()
Action
_soar_action
_api_client
_name
_action_start_time
_logger
_params
global_context
_entity_types
_entities_to_update
json_results
_attachments
_contents
_data_tables
_html_reports
_links
_entity_insights
_case_insights
_result_value
_output_message
_error_output_message
action_start_time
api_client
attachments
case_insights
contents
data_tables
entities_toupdate
- <a href="/chronicle/docs/soar/marketplace-integrations/tipcommon/tc-base#base-action-entityinsights">
entityinsights
entity_types
error_output_message
execution_state
html_reports
is_first_run
links
logger
name
output_message
params
result_value
run()
soar_action
EnrichAction
ActionParamType
Attachment
CaseAttachment
CaseComment
CaseInsight
CasePriority
CaseStage
CloseCaseOrAlertInconclusiveRootCauses
CloseCaseOrAlertMaintenanceRootCauses
CloseCaseOrAlertMaliciousRootCauses
CloseCaseOrAlertNotMaliciousRootCauses
CloseCaseOrAlertReasons
Content
DataTable
EntityInsight
EntityTypesEnum
ADDRESS
ALERT
APPLICATION
CHILD_HASH
CHILD_PROCESS
CLUSTER
CONTAINER
CREDIT_CARD
CVE
CVE_ID
DATABASE
DEPLOYMENT
DESTINATION_DOMAIN
DOMAIN
EMAIL_MESSAGE
EVENT
FILE_HASH
FILE_NAME
GENERIC
HOST_NAME
IP_SET
MAC_ADDRESS
PARENT_HASH
PARENT_PROCESS
PHONE_NUMBER
POD
PROCESS
SERVICE
SOURCE_DOMAIN
THREAT_ACTOR
THREAT_CAMPAIGN
THREAT_SIGNATURE
URL
USB
USER
ExecutionState
FullDetailsConfigurationParameter
HTMLReport
IntegrationParamType
Link
ScriptParameter
Apiable
Authable
Logger
Session
Job
RefreshTokenRenewalJob
SuccessFailureTuple
validate_param_csv_to_multi_value()
JobParameter
ActionJsonOutput
ActionOutput
ConnectorJsonOutput
ConnectorOutput
alert_info_from_json()
TIPCommon.rest
build_credentials_from_sa()
build_credentials_from_sa_attr()
generate_jwt_from_credentials()
generate_jwt_from_sa()
get_adc()
get_auth_request()
get_impersonated_credentials()
get_secops_siem_tenant_credentials()
GcpErrorReason
GcpPermissions
extract_project_id_from_sa_email()
extract_project_id_from_sa_key()
get_http_client()
get_workload_sa_email()
retrieve_project_id()
validate_impersonation()
get_auth_session()
SoarApiErrorServer
batch_set_custom_field_values()
get_alert_events()
get_case_attachments()
get_case_overview_details()
get_connector_cards()
get_entity_data()
get_env_action_def_files()
get_federation_cases()
get_full_case_details()
get_installed_integrations_of_environment()
get_installed_jobs()
get_integration_full_details()
get_user_profile_cards()
get_workflow_instance_card()
list_custom_field_values()
list_custom_fields()
remove_case_tag()
save_attachment_to_case_wall()
set_alert_priority()
set_case_score_bulk()
set_custom_field_values()
validate_response()
data_models
Module
AlertCard
AlertEvent
AlertPriority
BaseAlert
BaseDataModel
CaseDataStatus
CaseDetails
CasePriority
CaseWallAttachment
ConnectorCard
ConnectorConnectivityStatusEnum
ConnectorParamTypes
ConnectorParameter
Container
CustomField
CustomFieldScope
CustomFieldValue
DatabaseContextType
EventPropertyField
FieldGroupItem
FieldItem
FieldsGroup
GoogleServiceAccount
InstalledIntegrationInstance
JobParamType
Parameter
SLA
ScriptContext
action_definition_name
alert_id
async_polling_interval_in_sec
async_total_duration_deadline
case_id
connector_context
default_result_value
environment
environment_api_key
execution_deadline_unix_time_ms
integration_identifier
integration_instance
job_api_key
max_json_result_size
original_requesting_user
parameters
script_timeout_deadline
target_entities
unique_identifier
use_proxy_settings
vault_settings
workflow_id
workflow_instance_id
to_json()
update()
SmimeEmailConfig
SmimeType
TypedContainer
UserProfileCard
encryption
Module
exceptions
Module
ActionSetupError
AlreadyExistsError
BadGatewayError
CaseResultError
ConnectorContextError
ConnectorProcessingError
ConnectorSetupError
ConnectorValidationError
DeadlineExceededError
EmptyMandatoryValues
EnrichActionError
FailedPreconditionError
GeneralActionException
GeneralConnectorException
GeneralJobException
GoogleCloudException
ImpersonationUnauthorizedError
InternalJSONDecoderError
InvalidArgumentError
InvalidTimeException
JobSetupError
NotFoundError
OauthError
ParameterExtractionError
ParameterValidationError
PermissionDeniedError
RefreshTokenRenewalJobException
ResourceExhaustedError
SDKWrapperError
SMIMEMailError
UnauthenticatedError
UnavailableError
extraction
Module
extract_action_param()
extract_configuration_param()
extract_connector_param()
extract_job_param()
extract_script_param()
get_connector_detailed_params()
filters
Module
filter_list_by_type()
filter_none_kwargs()
filter_old_alerts()
filter_old_ids()
filter_old_ids_by_timestamp()
pass_whitelist_filter()
ouath
Module
AuthenticationError
AuthorizedOauthClient
CredStorage
EncryptionError
OAuthAdapter
OauthManager
OauthToken
smp_io
Module
read_and_repair_existing_content()
read_content()
read_ids()
read_ids_by_timestamp()
write_content()
write_ids()
write_ids_with_timestamp()
smp_time
Module
change_timezone()
convert_string_to_timestamp()
datetime_to_rfc3339()
get_last_success_time()
get_timestamps()
get_timestamps_from_range()
is_approaching_action_timeout()
is_approaching_timeout()
save_timestamp()
siemplify_fetch_timestamp()
siemplify_save_timestamp()
validate_timestamp()
soar_ops
Module
create_slo_message()
get_clean_comment_body()
get_file()
get_secops_mode()
get_soar_case_comments()
get_user_by_id()
get_user_profile_cards_with_pagination()
is_slo_comment()
remove_prefix_from_comments()
save_file()
transformation
Module
add_prefix_to_dict()
add_prefix_to_dict_keys()
adjust_to_csv()
construct_csv()
convert_comma_separated_to_list()
convert_dict_to_json_result_dict()
convert_list_to_comma_string()
dict_to_flat()
flat_dict_to_csv()
get_unicode()
removeprefix()
removesuffix()
rename_dict_key()
string_to_multi_value()
utils
Module
camel_to_snake_case()
cast_keys_to_int()
clean_result()
create_and_write_to_tempfiles()
get_entity_original_identifier()
get_function_arg_names()
get_unique_items_by_difference()
is_empty_string_or_none()
is_first_run()
is_overflowed()
is_python_37()
is_test_run()
none_to_default_value()
platform_supports_1p_api()
platform_supports_db()
safe_cast_bool_value_from_str()
safe_cast_int_value_from_str()
validation
Module
Need more help? Get answers from Community members and Google SecOps professionals.