Application Settings

Methods described in this section relate to the application settings API. These methods can be accessed at TenableIE.application_settings.

class ApplicationSettingsAPI(api: APISession)[source]
details() → Dict[source]

Get the application settings

Returns:

The application settings objects

Return type:

dict

Examples

>>> tie.application_settings.get_settings()
update(**kwargs) → Dict[source]

Update the application settings

Parameters:

  • smtp_server_address (optional, str) – The IP address of the SMTP server to use to send mails.

  • smtp_server_port (optional, int) – The port of SMTP server to use to send mails.

  • smtp_account (optional, str) – The login to use to authenticate against SMTP server.

  • smtp_account_password (optional, str) – The password to use to authenticate against SMTP server.

  • smtp_use_start_tls (optional, bool) – Whether the startTLS SMTP command should be used to secure the connection to the SMTP server?

  • tls (optional, bool) – Whether the configured server should connect using TLS?

  • email_sender (optional, str) – The email address to display as the sender in the emails sent.

  • default_role_ids (optional, list[int]) – The default role identifiers.

  • default_profile_id (optional, int) – The default profile identifier.

  • internal_certificate (optional, str) – The certificate chain to use to verify certificates on TLS connections.

Returns:

The application settings objects

Return type:

dict

Example

>>> tie.application_settings.update_settings(
...     smtp_use_start_tls=True,
...     tls=False,
...     default_profile_id=1,
...     )