Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ User Management/ Modifying User Parameters
Updated on 2026-03-16 GMT+08:00
View PDF

Modifying User Parameters

Function

This API is used to modify user parameters.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{engine}/{project_id}/instances/{instance_id}/users/{user_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Message engine.

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

user_name

Yes

String

Username.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

new_password

No

String

New password.

It cannot be the username or the username spelled backwards.

The password must meet the following complexity requirements:

  • Can contain 8 to 32 characters.

  • Must contain at least three of the following character types:

    • Lowercase letters

    • Uppercase letters

    • Digits

    • Special characters include (`~!@#$ %^&*()-_=+|[{}]:'",<.>/?) and spaces, and cannot start with a hyphen (-).

user_name

No

String

Username.

user_desc

No

String

User description.

Response Parameters

Status code: 204

Modified.

None

Example Requests

Modifying user parameters

PUT https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/users/{user_name}

{
  "new_password" : "Cxxx3",
  "user_name" : "test",
  "user_desc" : "a test user"
}

Example Responses

None

Status Codes

Status Code

Description

204

Modified.

Error Codes

See Error Codes.

Parent Topic: User Management