Get the lockout settings
Return the lockout settings for the requested context, which define when a user will be locked
Query Parameters
- ctx.orgId string
- ctx.instance boolean
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs tosettings object
maxPasswordAttempts uint64Maximum 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.
resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instancePossible 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
{
"details": {
"sequence": "2",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
},
"settings": {
"maxPasswordAttempts": "10",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs tosettings object
maxPasswordAttempts uint64Maximum 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.
resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instancePossible 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
{
"details": {
"sequence": "2",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
},
"settings": {
"maxPasswordAttempts": "10",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs tosettings object
maxPasswordAttempts uint64Maximum 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.
resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instancePossible 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
{
"details": {
"sequence": "2",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
},
"settings": {
"maxPasswordAttempts": "10",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}