Update application settings

patch

https://{customer}.tenable.ad/api/application-settings

Updates the application settings.

Requires one of the following license types: ioa, ioaPreview, or ioe. See License Types.

Requires the Edit permission on the Application services entity (edit:application-setting). Changing defaultRoleIds also requires the Edit permission on the Roles entity (edit:role). See Identity Exposure Permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Application settings

userRegistration

boolean

Specifies whether users can register an account themselves.

activityLogsIsActive

boolean

Specifies whether activity logs are recorded.

activityLogsRetentionDurationInMonth

integer | null

enum

Specifies how many months activity logs are kept.

Allowed:

tls

boolean

Specifies whether to use TLS for the connection to the SMTP server.

emailSender

string

Specifies the sender address of the email notifications.

defaultRoleIds

array of integers

Specifies the IDs of the roles that new users receive by default.

defaultRoleIds

defaultProfileId

integer

Specifies the ID of the default security profile for new users.

internalCertificate

string | null

Specifies the internal certificate.

telemetryEnabled

boolean

Specifies whether telemetry is enabled.

ioaAutomaticConfiguration

boolean

Specifies whether Indicators of Attack are configured automatically.

cloudStatisticsIsActive

boolean

Specifies whether usage statistics are sent to Tenable Cloud.

healthCheckGlobalStatusDisplayEnabled

boolean

Specifies whether the global health check status is displayed in the interface.

smtpServerAddress

string | null

Specifies the address of the SMTP server that sends email notifications.

smtpServerPort

integer | null

Specifies the port of the SMTP server.

smtpAccount

string | null

Specifies the account used to authenticate to the SMTP server.

smtpAccountPassword

string | null

Specifies the password of the SMTP account.

smtpUseStartTLS

boolean

Specifies whether to use STARTTLS for the connection to the SMTP server.

smtpRelayId

number | null

Specifies the ID of the relay that connects to the SMTP server.

smtpRelayUuid

string | null

Specifies the unique identifier (UUID) of the relay that connects to the SMTP server.

smtpAuthenticationMethod

string | null

enum

Specifies how to authenticate to the SMTP server: basic for an account and password, or office365 for Microsoft 365 OAuth.

Allowed:

smtpOffice365TenantId

string | null

Specifies the Microsoft 365 tenant ID. Applies when smtpAuthenticationMethod is office365.

smtpOffice365ClientId

string | null

Specifies the Microsoft 365 client ID. Applies when smtpAuthenticationMethod is office365.

smtpOffice365Secret

string | null

Specifies the Microsoft 365 client secret. Applies when smtpAuthenticationMethod is office365.

smtpOffice365SenderEmail

string | null

Specifies the sender email address for Microsoft 365. Applies when smtpAuthenticationMethod is office365.

smtpOffice365SenderName

string | null

Specifies the sender name for Microsoft 365. Applies when smtpAuthenticationMethod is office365.

Responses

401

Returned if the API key specified in your request is invalid.

500

Returned if an internal error occurred.

200Returned if the application settings were updated successfully.