Creating a User
Function
This API is used to create a user for a Kafka instance for which SASL is enabled.
URI
POST /v2/{project_id}/instances/{instance_id}/users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request 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:
|
Response Parameters
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
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 |
The creation is successful. |
400 |
Invalid parameters. |
403 |
Authentication failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.