Change user name

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

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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

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.

application/json

Bodyrequired

userNamestringrequired
Possible values: non-empty and <= 200 characters
Example: minnie-mouse-updated

application/grpc

Bodyrequired

userNamestringrequired
Possible values: non-empty and <= 200 characters
Example: minnie-mouse-updated

application/grpc-web+proto

Bodyrequired

userNamestringrequired
Possible values: non-empty and <= 200 characters
Example: minnie-mouse-updated

Responses

200

OK

application/json

Schema

Schema

details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

Schema

details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

Schema

details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Authorization: oauth2

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://$CUSTOM-DOMAIN/management/v1/users/:userId/username");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"userName\": \"minnie-mouse-updated\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/management/v1

Auth

Bearer Token

Parameters

userId — pathrequired

x-zitadel-orgid — header

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "userName": "minnie-mouse-updated"
}

ResponseClear

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