ZITADEL Docs
APIsCore ResourcesV2User

LockUser

Lock user

The state of the user will be changed to 'locked'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'locked'. Use this endpoint if the user should not be able to log in temporarily because of an event that happened (wrong password, etc.)..

POST
/v2/users/{user_id}/lock

Path Parameters

user_id*string

Response Body

application/json

application/json

curl -X POST "https://loading/v2/users/string/lock"
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?