Security Settings:Update Security Settings

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

New in this release

Update Security Settings

PUT /config-admin/security

Update user security settings, supported settings are:

passwordRulesEnabled
passwordMinTotalCharCount
passwordMaxTotalCharCount
passwordMinUppercaseCharCount
passwordMinLowercaseCharCount
passwordMinNumericCharCount
passwordMinSpecialCharCount
passwordMinCharChange
passwordExpiryDays
passwordMinLifeTimeHours
passwordHistoryCount
userMaxLoginAttempts
userInactiveLockDays
sessionMaxActiveCountPerUser
sessionMaxLifeTimeMinutes
sessionMaxIdleTimeMinutes
sessionMaxUIIdleTimeMinutes
userAgreementText

Required Roles

This call has no restrictions.

Request Payload

<security_config_update_request>
</security_config_update_request>

{}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
security_config_update_request

Response Body

Indicating success or failure of the update operation

Examples

Request

PUT https://192.168.0.0:4443/config-admin/security

Accept: application/xml
Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>


<security_config_update_request>
    <update_entries>
        <entry>
            <key>sessionMaxIdleTimeMinutes</key>
            <value>120</value>
        </entry>
        <entry>
            <key>passwordExpiryDays</key>
            <value>30</value>
        </entry>
    </update_entries>
</security_config_update_request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

Request

PUT https://192.168.0.0:4443/config-admin/security

Accept: application/json
Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>


{
    "update_entries": {
        "passwordMinTotalCharCount": "8",
        "passwordExpiryDays": "60",
        "sessionMaxUIIdleTimeMinutes": "15",
        "sessionMaxActiveCountPerUser": "100",
        "passwordMinLowercaseCharCount": "1",
        "passwordRulesEnabled": "false",
        "sessionMaxLifeTimeMinutes": "480",
        "userAgreementText": "",
        "userMaxLoginAttempts": "5",
        "passwordMaxTotalCharCount": "256",
        "passwordHistoryCount": "5",
        "userInactiveLockDays": "35",
        "passwordMinUppercaseCharCount": "1",
        "passwordMinSpecialCharCount": "1",
        "sessionMaxIdleTimeMinutes": "120",
        "passwordMinLifeTimeHours": "24",
        "passwordMinNumericCharCount": "1",
        "passwordMinCharChange": "3"
    }
}

Response

HTTP/1.1 200 OK
Content-Type: application/json