How to Configure API User using OpenStack SDK?

What is the purpose of the API Users tab in the Cloud Control Panel?

The API Users tab in the Cloud Control Panel gives you access to the OpenStack API. The API can be used to perform a wide range of server management activities.

This guide will walk you through the process to configure API user using OpenStack SDK.

If you receive an "Incorrect email or password" error, you may proceed by selecting "Forgot Password." For guidance, please refer to our Helpdesk article: How to Reset Your Password for the Cloud Control Panel

In the left sidebar, click on the 'API users' tab. Download the OpenRC file by clicking on the Get OpenRC file. This will download a file we'll be using for authorization.

If you haven’t created the API users yet, you may refer to this guideline: How to Create API Users?

Choose MY-CJ1 region and click Get File to download the OpenRC file.

Access your server terminal and upload the openrc file into the server. You'll see the file is available on the server.

Next, install the necessary dependencies and applications to proceed further. Run the command below to install.

yum -y install python3-pip
yum -y install epel-release.noarch
yum -y install python3-virtualenv
python3 -m venv .venv

Activate the .venv by using the command below. After you have run the command, you will be redirected to the (.venv) environment

yum source .venv/bin/activate

Run the command below to install the pip package. Make sure to run it in the (.venv) environment.

pip install -U pip

Install the python-openstackclient and openstacksdk using the below command.

pip install python-openstackclient
pip install openstacksdk==3.3.0

Run the command below to connect to the openrc file that we have uploaded in Step 4. Then, enter the password of the API user that has been set before. You can refer to this guideline for the section on setting the password.

source openrc

You can verify by running the command below. The command below is the list of projects assigned to your GB Cloud account. You can get more command lists on OpenStack's official documentation.

openstack project list

You have successfully configure API User using OpenStack SDK

If you face any issues or need assistance, don’t hesitate to reach out — our support team is always ready to help!

🔧 Need help? Submit a Support Ticket

💬 Chat with us on Live Chat via our website

Updated on: 26/08/2025

Was this article helpful?

Thank you!