Get Password Lockout Settings
GEThttps://$CUSTOM-DOMAIN/management/v1/policies/lockout
Returns the password lockout settings configured on the organization. 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.
Request​
Header Parameters
x-zitadel-orgid string
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.
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
policy
object
isDefault deprecated: is_default is also defined in zitadel.policy.v1.LockoutPolicy (boolean)
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2025-02-17T18:27:34.966Z",
"changeDate": "2025-02-17T18:27:34.966Z",
"resourceOwner": "69629023906488334"
},
"maxPasswordAttempts": "10",
"maxOtpAttempts": "10",
"isDefault": true
},
"isDefault": true
}
- Schema
- Example (from schema)
Schema
policy
object
isDefault deprecated: is_default is also defined in zitadel.policy.v1.LockoutPolicy (boolean)
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2025-02-17T18:27:34.966Z",
"changeDate": "2025-02-17T18:27:34.966Z",
"resourceOwner": "69629023906488334"
},
"maxPasswordAttempts": "10",
"maxOtpAttempts": "10",
"isDefault": true
},
"isDefault": true
}
- Schema
- Example (from schema)
Schema
policy
object
isDefault deprecated: is_default is also defined in zitadel.policy.v1.LockoutPolicy (boolean)
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2025-02-17T18:27:34.966Z",
"changeDate": "2025-02-17T18:27:34.966Z",
"resourceOwner": "69629023906488334"
},
"maxPasswordAttempts": "10",
"maxOtpAttempts": "10",
"isDefault": true
},
"isDefault": true
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://$CUSTOM-DOMAIN/management/v1/policies/lockout' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear