ZITADEL Docs
APIsCore ResourcesV2User

UpdateUser

Update a User

Partially update an existing user. If you change the users email or phone, you can specify how the ownership should be verified. If you change the users password, you can specify if the password should be changed again on the users next login.

Required permission:

  • user.write
PATCH
/v2/users/{user_id}

Path Parameters

user_id*string

The user id is the users unique identifier in the instance. It can't be changed.

Request Body

application/json

username?string

Set a new username that is unique within the instance. Beware that active tokens and sessions are invalidated when the username is changed.

human*
[key: string]?never

Response Body

application/json

application/json

curl -X PATCH "https://loading/v2/users/string" \  -H "Content-Type: application/json" \  -d '{    "human": {}  }'
{
  "changeDate": "1s",
  "emailCode": "string",
  "phoneCode": "string"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?