Help Center> Distributed Message Service for Kafka> API Reference> APIs V2 (Recommended)> User Management> Creating a User
View PDF

Creating a User

Function

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

Debugging

You can use API Explorer to debug this API.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Username.

user_passwd

No

String

User password.

The password must be different from the username. The password must meet the following complexity requirements:

  • Can be 8 to 32 characters long.

  • Contains at least two of the following character types:

  • Lowercase letters

  • Uppercase letters

  • Digits

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

Response Parameters

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.

Example Requests

Creating a User

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

{
  "user_name" : "test",
  "user_passwd" : "Cloud@123"
}

Example Responses

None

Status Codes

Status Code

Description

204

Creation succeeded.

400

Invalid parameters.

403

Authorization failed.

Error Codes

See Error Codes.

Parent topic: User Management