Docs

Message Queue for Kafka

User management

Bulk import SASL users

In scenarios such as migrating applications to the cloud or instance backup, if you need to create multiple SASL users at one time, you can create SASL users in bulk by uploading a configuration file through the console. This topic describes the steps to bulk import SASL users.

Background information

In scenarios such as migrating applications to the cloud or instance backup, you need to create a batch of Topics in the new instance with the same configuration as the source Topics, such as the Topic name, number of partitions, message retention time, and other configuration settings. Message Queue for Kafka supports bulk creation of SASL users by uploading configuration files through the console. You can prepare the SASL user configuration file based on the specified template format and upload it to the Message Queue for Kafka console. The backend system service automatically creates SASL users with the specified configuration for you.

Note

Only supports CSV format configuration files. The maximum file size is 10 MB.

Each bulk import supports up to 200 SASL user configurations. You can batch create up to 200 SASL users at one time.

For instance created before August 23, 2023, importing PLAIN users is not supported.

Prerequisites

Before batch importing SASL users in the console, prepare the configuration file based on the template provided by the console. The file should include configuration information such as usernames.

You can click Bulk import users on User management page, and then download the configuration template. After that, fill in the SASL user information that needs to be imported according to the prompts.

tip

In the configuration file, every column is required. Otherwise, the template parsing will fail during upload. However, All Permitted can be left empty. This means All Permitted is set to false. Under this setting, user does not have read/write permissions for all Topics. Description can also be left empty. Under this setting, no description information is provided.

Parameter configuration must meet the requirements. For detailed rules, refer to the template header.

Operation steps

Select the region where the instance is located on the top menu bar.

Click the specified instance name on the Instances page.

Click User management on the tab bar.

Click Bulk import users.

Upload the configuration file as prompted on the page.

If the page shows File configuration validation passed, the configuration file is parsed correctly. Proceed with the next steps.

If the page shows file data validation failed, please correct according to the prompt, errors exist in configuration file. Modify the parameters based on the prompts and upload the configuration file again.

Click Create import task.

The backend service will create SASL users in bulk based on the uploaded configuration file. Besides, it creates a task to view the task execution details simultaneously.

If new SASL users appear in the user list, the SASL users are created successfully and can be used immediately.

In Background task management, if the background task remains in Running state for a long time, or other abnormalities occur on the Task management tab, you can view detailed execution information in the Task details column.

Last updated: 2025.10.15 10:11:16