From 473dccfa8e495fa2cc5312e72e3e6238c3aaeefe Mon Sep 17 00:00:00 2001 From: Ihor Aleksandrychiev Date: Thu, 5 Sep 2024 12:15:15 +0300 Subject: [PATCH] Updated Settings API documentation Ticket: ENT-10841 Signed-off-by: Ihor Aleksandrychiev --- .../status-settings.markdown | 52 ++++++++++++------- 1 file changed, 32 insertions(+), 20 deletions(-) diff --git a/api/enterprise-api-ref/status-settings.markdown b/api/enterprise-api-ref/status-settings.markdown index 378b71d8f..53053f9c6 100644 --- a/api/enterprise-api-ref/status-settings.markdown +++ b/api/enterprise-api-ref/status-settings.markdown @@ -88,12 +88,15 @@ API call allowed only for administrator. }, "data": [ { - "hostIdentifier": "default.sys.fqhost", - "rbacEnabled": true, - "logLevel": "error", - "ldapEnabled": true, - "blueHostHorizon": 900, - "sameHostsNumberOfRuns": 3 + "blueHostHorizon": 2400, + "enforce2FA": false, + "hostIdentifier": "default.sys.fqhost", + "hostsCollisionsThreshold": 3, + "logLevel": "error", + "minPasswordLength": 8, + "passwordComplexity": 3, + "passwordExpirationAfterResetHours": 48, + "rbacEnabled": true } ] } @@ -109,8 +112,25 @@ API call allowed only for administrator. Whether external authentication is activated. * **logLevel** *("emergency", "alert", "critical", "error", "warning", "notice", "info", "debug")* Syslog filter specifying the severity level at which messages produced by the API should be emitted to syslog and apache.log. (default: error). +* **blueHostHorizon** *(900)* + Threshold in minutes that hosts are unreachable before they are considered a health issue. * **sameHostsNumberOfRuns** *(integer)* Number of samples used to identify a duplicate identity. Default value is 3. +* **enforce2FA** *(boolean)* + Determines if two-factor authentication (2FA) is mandatory for all users. + If set to `true`, users must enable 2FA; otherwise, they will be locked out within 48 hours after the first login. + Default value: `false` +* **minPasswordLength** *(integer)* + Sets the minimum required length for user passwords. + The value represents the number of characters. + Default value: `8` +* **passwordComplexity** *(integer)* + Defines the level of password complexity required. + The range is from 0 to 4, where zero turns of the password complexity check and four turns on the maximum level. + Default value: `3` +* **passwordExpirationAfterResetHours** *(integer)* + Specifies the number of hours after which a password will expire following a reset. + Default value: `48` **Example usage:** `Example: Viewing settings` @@ -126,19 +146,7 @@ administrator. **Fields**: -* **rbacEnabled** *(boolean)* - Whether RBAC is applied to requests. -* **hostIdentifier** *(string)* - The identfying string for hosts, such as name or IP. -* **ldapEnabled** *(boolean)* - Whether external authentication is activated. -* **logLevel** *("emergency", "alert", "critical", "error", "warning", "notice", "info", "debug")* - Syslog filter specifying the severity level at which messages produced by the API should be emitted to syslog and apache.log. (default: error). -* **blueHostHorizon** *(900)* - Threshold in minutes that hosts are unreachable before they are considered a health issue. -* **sameHostsNumberOfRuns** *(integer)* - Number of samples used to identify a duplicate identity. Default value is 3. - +See [Get settings][Status and settings REST API#Get settings] section for field descriptions **Example Request Body:** @@ -149,7 +157,11 @@ administrator. "logLevel": "error", "ldapEnabled": true, "blueHostHorizon": 900, - "sameHostsNumberOfRuns": 5 + "sameHostsNumberOfRuns": 5, + "minPasswordLength": 12, + "passwordComplexity": 4, + "passwordExpirationAfterResetHours": 24, + "enforce2FA": true } ```