Creating a User
Function
This API is used to create a user for a Kafka instance for which SASL is enabled.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/instances/{instance_id}/users
| 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. |
Request 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: |
Response Parameters
Status code: 204
The creation is successful.
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 whose username is test and password is Cxxx3
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
{
"user_name" : "test",
"user_passwd" : "Cxxx3"
} 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.