Skip to content

Commit

Permalink
Updated Settings API documentation
Browse files Browse the repository at this point in the history
Ticket: ENT-10841
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
  • Loading branch information
aleksandrychev committed Sep 6, 2024
1 parent 6487bd8 commit 473dccf
Showing 1 changed file with 32 additions and 20 deletions.
52 changes: 32 additions & 20 deletions api/enterprise-api-ref/status-settings.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
]
}
Expand All @@ -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`
Expand All @@ -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:**

Expand All @@ -149,7 +157,11 @@ administrator.
"logLevel": "error",
"ldapEnabled": true,
"blueHostHorizon": 900,
"sameHostsNumberOfRuns": 5
"sameHostsNumberOfRuns": 5,
"minPasswordLength": 12,
"passwordComplexity": 4,
"passwordExpirationAfterResetHours": 24,
"enforce2FA": true
}
```

Expand Down

0 comments on commit 473dccf

Please sign in to comment.