Update login settings
PUT /api/2.0/settings/security/loginSettings
Request
Updates the login settings with the parameters specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key
.
Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
,text/json
,text/plain
.- Content-Type
enum of string
Can be one of:
application/json
,application/*+json
,text/json
.
Body
Login settings request parameters
- attemptCount
integer
int32 Maximum number of the user attempts to log in
- blockTime
integer
int32 The duration of the account suspension for unsuccessful login attempts
- checkPeriod
integer
int32 Expected server response time
Examples
PUT /api/2.0/settings/security/loginSettings HTTP/1.1
Accept: application/json
Content-Length: 70
Content-Type: application/json
Host: example.com
{
"attemptCount": 1234,
"blockTime": 1234,
"checkPeriod": 1234
}
curl --request PUT \
--url https://example.com/api/2.0/settings/security/loginSettings \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"attemptCount": 1234,
"blockTime": 1234,
"checkPeriod": 1234
}'
Responses
200
Updated login settings
- attemptCount
integer
int32 Maximum number of the user attempts to log in
- blockTime
integer
int32 The time for which the user will be blocked after unsuccessful login attempts
- checkPeriod
integer
int32 The time to wait for a response from the server
401
Unauthorized
403
Forbidden