Get Default Password Lockout Settings​
Returns the default password lockout settings configured on the instance. The settings specify when a user should be locked (e.g how many password attempts). The user has to be unlocked by an administrator afterward.
Header Parameters
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
- 200
- default
A successful response.
Schema
policy object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset. If set to 0 the account will never be locked.
Maximum failed attempts for a single OTP type (TOTP, SMS, Email) before the account gets locked. Attempts are reset as soon as the OTP is entered correctly. If set to 0 the account will never be locked.
defines if the organization's admin changed the policy
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.666Z",
"changeDate": "2024-06-13T06:44:37.666Z",
"resourceOwner": "69629023906488334"
},
"maxPasswordAttempts": "10",
"maxOtpAttempts": "10",
"isDefault": true
}
}
Schema
policy object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset. If set to 0 the account will never be locked.
Maximum failed attempts for a single OTP type (TOTP, SMS, Email) before the account gets locked. Attempts are reset as soon as the OTP is entered correctly. If set to 0 the account will never be locked.
defines if the organization's admin changed the policy
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.667Z",
"changeDate": "2024-06-13T06:44:37.667Z",
"resourceOwner": "69629023906488334"
},
"maxPasswordAttempts": "10",
"maxOtpAttempts": "10",
"isDefault": true
}
}
Schema
policy object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset. If set to 0 the account will never be locked.
Maximum failed attempts for a single OTP type (TOTP, SMS, Email) before the account gets locked. Attempts are reset as soon as the OTP is entered correctly. If set to 0 the account will never be locked.
defines if the organization's admin changed the policy
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.667Z",
"changeDate": "2024-06-13T06:44:37.667Z",
"resourceOwner": "69629023906488334"
},
"maxPasswordAttempts": "10",
"maxOtpAttempts": "10",
"isDefault": true
}
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}