ZITADEL Docs
APIsCore ResourcesV1Organization Objects

Change user name

Deprecated: use user service v2 UpdateUser instead.

Change the username of the user. Be aware that the user has to log in with the newly added username afterward.

PUT
/users/{user_id}/username

Path Parameters

user_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userName*string

Response Body

application/json

curl -X PUT "https://loading/users/string/username" \  -H "Content-Type: application/json" \  -d '{    "userName": "string"  }'
{
  "details": {
    "sequence": 0,
    "creationDate": "2023-01-15T01:30:15.01Z",
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string"
  }
}

Was this page helpful?

Change Project Role

Change Project Role: Deprecated: use [project v2 service UpdateProjectRole](/reference/api/project/zitadel.project.v2.ProjectService.UpdateProjectRole) instead. Change a project role. The key is not editable. If a key ...

Check for existing user

Check for existing user: Deprecated: use [user service v2 ListUsers](/reference/api/user/zitadel.user.v2.UserService.ListUsers) instead, is unique if no user returned. Returns if a user with the requested email or username...