Summary:
List global user settings, modify global user settings, and update all existing users to those global user settings.
URL:
http(s)://{server hostname}/api/settings/globalUserSettings
Methods summary
- GET Method - returns details about global user settings.
- PUT Method - modifies global user settings.
- POST Method - update all existing users to the global settings.
GET Method detail
Returns details about global user settings.
Response:
Global user setting structure with the following format:
| Name | Description |
|---|---|
|
lockAttempts |
number of failed login attempts before locking the account. Value -1 to disable. |
|
lockDurationFailedAttempts |
duration (minutes) the account is locked for after reaching maximum failed attempts. |
|
timeoutMinutes |
number of minutes after which session becomes inactive. Value -1 to disable. |
|
pwChangeDays |
days to password change. Value -1 to disable. |
|
pwChangeNoticePeriod |
number of days to display a warning before a password change is required. Value 0 to disable. |
Example:
INPUT
curl -u admin:admin https://localhost/api/settings/globalUserSettings?media=json
OUTPUT
{
"pwChangeDays" : 30,
"pwChangeNoticePeriod" : 10,
"timeoutMinutes" : 20,
"lockAttempts" : 3,
"lockDurationFailedAttempts" : 5,
}
PUT Method detail
Modifies global user settings.
Request:
Same as 'GET Method - Response' table above.
Response:
Modified global user settings.
Example:
INPUT
curl -u admin:admin https://localhost/api/settings/globalUserSettings?media=xml -X PUT -H "content-type:application/json" -d \
'{
"lockAttempts" : 5,
"lockDurationFailedAttempts" : 10
}'
OUTPUT
{
"pwChangeDays" : 30,
"pwChangeNoticePeriod" : 10,
"timeoutMinutes" : 20,
"lockAttempts" : 5,
"lockDurationFailedAttempts" : 10,
}
POST Method detail
Updates existing users to the global user settings.
Response:
| Name | Description |
|---|---|
| message | if the user settings reset for all existing users was successful. User-specific settings are not affected. |
Example:
INPUT
curl -u admin:admin https://localhost/api/settings/globalUserSettings/resetAllUsersSettings -X POST -H "content-type:application/json"
OUTPUT
{
"message" : "Success. All existing users settings now match the global user settings. User-specific settings are not affected."
}
Comments
0 comments
Please sign in to leave a comment.