Creating a User¶

Function¶

This API is used to create a user for a Kafka instance for which SASL is enabled.

POST /v2/{project_id}/instances/{instance_id}/users

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
user_name	No	String	Username. This parameter is mandatory for creating a user.
user_desc	No	String	User description.
user_passwd	No	String	Password. This parameter is mandatory for creating a user. The password must be different from the username. 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 (-).

Status code: 400

**Table 3** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 4** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Creating a user whose username is test and password is Cxxx3

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users

{
  "user_name" : "test",
  "user_passwd" : "Cxxx3"
}

None

last updated: 2024-12-10 15:16 UTC - commit: ef506946dc65402760f4eb57bfda5ee36d4df62f