pycti.entities.opencti_settings
Classes
Represents the Settings object in OpenCTI |
Module Contents
- class pycti.entities.opencti_settings.Settings(opencti)[source]
Represents the Settings object in OpenCTI
These are the properties which are viewable in the customization and security policies views on OpenCTI platform. This also includes all messages on the platform.
See the properties attribute to understand which properties are fetched by default on graphql queries.
- Parameters:
opencti (OpenCTIApiClient) – instance of
OpenCTIApiClient
Initialize the Settings instance.
- Parameters:
opencti (OpenCTIApiClient) – OpenCTI API client instance
- properties = Multiline-String[source]
Show Value
""" id standard_id entity_type parent_types platform_organization { id, name, description } platform_title platform_favicon platform_email platform_url platform_language platform_cluster { instances_number } platform_modules { id, enable, warning } platform_providers { name, type, strategy, provider } platform_user_statuses { status, message } platform_theme { id standard_id entity_type parent_types name theme_background theme_paper theme_nav theme_primary theme_secondary theme_accent theme_logo theme_logo_collapsed theme_logo_login theme_text_color built_in } platform_map_tile_server_dark platform_map_tile_server_light platform_ai_enabled platform_openaev_url platform_opengrc_url platform_ai_type platform_ai_model platform_ai_has_token platform_login_message platform_consent_message platform_consent_confirm_text platform_banner_text platform_banner_level platform_session_idle_timeout platform_session_timeout platform_whitemark platform_demo platform_reference_attachment platform_feature_flags { id, enable, warning } platform_critical_alerts { message, type details { groups { id, name, description } } } platform_trash_enabled platform_protected_sensitive_config { enabled markings { enabled, protected_ids } groups { enabled, protected_ids } roles { enabled, protected_ids } rules { enabled, protected_ids } ce_ee_toggle { enabled, protected_ids } file_indexing { enabled, protected_ids } platform_organization { enabled, protected_ids } } created_at updated_at platform_enterprise_edition { license_enterprise license_by_configuration license_customer license_validated license_valid_cert license_expired license_expiration_prevention license_start_date license_expiration_date license_platform license_type license_platform_match license_creator license_global } analytics_google_analytics_v4 activity_listeners { id, name, entity_type } """
- messages_properties = Multiline-String[source]
Show Value
""" entity_type platform_messages { id, message, activated, dismissible, updated_at, color recipients { id, name, entity_type } } messages_administration { id, message, activated, dismissible, updated_at, color recipients { id, name, entity_type } } """
- password_policy_properties = Multiline-String[source]
Show Value
""" otp_mandatory password_policy_min_length password_policy_max_length password_policy_min_symbols password_policy_min_numbers password_policy_min_words password_policy_min_lowercase password_policy_min_uppercase """
- editable_properties = Multiline-String[source]
Show Value
""" id platform_organization { id } platform_title platform_favicon platform_email platform_language platform_login_message platform_consent_message platform_consent_confirm_text platform_banner_text platform_banner_level platform_whitemark analytics_google_analytics_v4 otp_mandatory password_policy_min_length password_policy_max_length password_policy_min_symbols password_policy_min_numbers password_policy_min_words password_policy_min_lowercase password_policy_min_uppercase """
- read(**kwargs) Dict[source]
Reads settings from the platform
- Parameters:
customAttributes (str, optional) – Custom attribues to return from query
include_password_policy (bool, optional) – Defaults to False. Whether to include password policy properties in response.
include_messages (bool, optional) – Defaults to False. Whether to include messages in query response.
- Returns:
Representation of the platform settings
- Return type:
Dict
- update_field(**kwargs) Dict | None[source]
Update settings using input to fieldPatch
- Parameters:
id (str) – ID of the settings object to update
input (List[Dict]) – List of EditInput objects
customAttributes (str, optional) – Custom attribues to return from query
include_password_policy (bool, optional) – Defaults to False. Whether to include password policy properties in response.
include_messages (bool, optional) – Defaults to False. Whether to include messages in query response.
- Returns:
Representation of the platform settings
- Return type:
Optional[Dict]
- edit_message(**kwargs) Dict | None[source]
Edit or add a message to the platform
To add a message, don’t include an ID in the input object. To edit a message an ID must be provided.
- Parameters:
id (str) – ID of the settings object on the platform
input (Dict) – SettingsMessageInput object
- Returns:
Settings ID and message objects
- Return type:
Optional[Dict]