SystemSettingsLockoutPolicy

SystemSettingsLockoutPolicy - List

Lists the Lockout policy Settings.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SystemSettingsLockoutPolicy

Success Response

[
    {
        "failed_login": 7,
        "id": "4f031d6bccba252fb00fbf61",
        "locked_out_time": 20
    }
]

SystemSettingsLockoutPolicy - PolicyReset

Resets the Lockout policy parameters to default values. The default value for locked_out_time is 30 minutes and the default value for the failed_login is 5.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SystemSettingsLockoutPolicy/policyreset

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

SystemSettingsLockoutPolicy - Save

Updates the existing Lockout policy Settings.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SystemSettingsLockoutPolicy

Parameter

Field

Label in UI

Type

Description

failed_login

Lockout threshold

int

Number of failed attempts at logon a user is allowed before the account is locked out. Default value is 5. Mandatory Field

locked_out_time

Lockout duration

int

Time in minutes that the account can be locked out. Default value is 30. Mandatory Field

Request Example

{
    "data": {
        "failed_login": 5,
        "locked_out_time": 30
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?

We are glad this guide helped.


Please don't include any personal information in your comment

Contact Support