Skip to main content

Change user name

PUT 
https://$CUSTOM-DOMAIN/management/v1/users/:userId/username
deprecated

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

Deprecated: please use user service v2 UpdateHumanUser

Request​

Path Parameters

    userId stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization.

Body

required

    userName stringrequired

    Possible values: non-empty and <= 200 characters

Responses​

OK

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/username' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "userName": "minnie-mouse-updated"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{
  "userName": "minnie-mouse-updated"
}
ResponseClear

Click the Send API Request button above and see the response here!