GET /userAccountSettings
Use GET to retrieve the current or default security settings for the user accounts.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/userAccountSettings
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| default={Boolean} | Optional | Indicates whether to return the default account security settings. This can be one of the following values.
|
GET https://192.0.2.0/userAccountSettings?default=true
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| response | Array | Each array element represents a user account | ||
| InactivityTimeout | Integer | Amount of time, in minutes, that a user session that is established with the Lenovo XClarity Administrator can be inactive before the user is logged off | ||
| LockoutTime | Integer | Minimum amount of time, in minutes, that must pass before a user that was locked out can attempt to log back in again | ||
| MaxConcurrentSessions | Integer | Maximum number of active sessions for a specific user that is allowed at any given time. | ||
| MaximumLoginFailures | Integer | Maximum number of times that a user can attempt to log in with an incorrect password before the user account is locked out. The number specified for the lockout period after maximum login failures determines how long the user account is locked out. Accounts that are locked cannot be used to gain access to the system even if a valid password is provided. | ||
| MaximumPasswordExpiration | Integer | Amount of time, in days, that a user can use a password before it must be changed. Smaller values reduce the amount of time for attackers to guess passwords | ||
| MaximumPasswordLength | Integer | Maximum number of characters that can be used to specify a valid password | ||
| MinimumChangeTime | Integer | Minimum amount of time, in hours, that must elapse before a user can change a password again after it was previously changed. The value specified for this setting cannot exceed the value specified for the password expiration period. | ||
| MinimumDifferentChars | Integer | Minimum number of characters that must be changed between the current password and a new password when the password is changed | ||
| MinimumPasswordLength | Integer | Minimum number of characters that can be used to specify a valid password | ||
| PasswordChangeFirstAccess | Boolean | Indicates whether a user is required to change the password when the user logs in to XClarity Administrator for the first time. This can be one of the following values.
| ||
| PasswordExpirationWarningPeriod | Long | Amount of time, in days, before the password expiration date that users begin to receive warnings about the impending expiration of the user password | ||
| PasswordHistoryDepth | Integer | Minimum number of times that a user must enter a unique password when changing the password before the user can start to reuse passwords | ||
| SimplePasswordRules | Boolean | Indicates whether simple password rules are in effect. This can be one of the following values.
| ||
| MinPasswordComplexityRules | Integer | Number of complexity rules that must be followed when creating a new password Rules are enforced starting with rule 1, and up to the number of rules specified. For example, if the password complexity is set to 4, then rules 1, 2, 3 and 4 must be followed. If the password complexity is set to 2, then rules 1 and 2 must be followed. This can be a value from 0 – 5. The default is 4. XClarity Administrator supports the following password complexity rules.
If set to 0, passwords are not required to comply with any complexity rules. | ||
| result | String | Request results. This can be one of the following values.
| ||
| messages | Array of objects | Information about one or more messages | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | The message identifier of a returned message | ||
| recovery | Array of objects | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||
| text | String | Message text associated with the message identifier | ||
{
"response": {
"InactivityTimeout": 1440,
"LockoutTime": 60,
"MaxConcurrentSessions": 3,
"MaximumLoginFailures": 20,
"MaximumPasswordExpiration": 90,
"MaximumPasswordLength": 20,
"MinimumChangeTime": 24,
"MinimumDifferentChars": 2,
"MinimumPasswordLength": 8,
"PasswordChangeFirstAccess": true,
"PasswordExpirationWarningPeriod": 5,
"PasswordHistoryDepth": 5,
"SimplePasswordRules": false,
"MinPasswordComplexityRules": 5
},
"result": "success",
"messages": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}