Get the lockout settings​
Return the lockout settings for the requested context, which define when a user will be locked
Query Parameters
- 200
- 403
- 404
- default
OK
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
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.
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the settings is managed on the organization or on the instance
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.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.932Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"maxPasswordAttempts": "10",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"maxOtpAttempts": "10"
}
}
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
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.
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the settings is managed on the organization or on the instance
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.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.932Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"maxPasswordAttempts": "10",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"maxOtpAttempts": "10"
}
}
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
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.
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the settings is managed on the organization or on the instance
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.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.932Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"maxPasswordAttempts": "10",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"maxOtpAttempts": "10"
}
}
Returned when the user does not have permission to access the resource.
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"
}
]
}
Returned when the resource does not exist.
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"
}
]
}
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"
}
]
}