Skip to content

Configure API-Access

Goal

  • Authenticating to use the firstcloud API

Prerequisites

  • You need to have the login data for the firstcloud API (user name and passphrase).
  • The OpenStack CLI-Tools are installed in an up-to-date version.
  • Knowledge how to utilise a terminal/SSH and SSH-keys.

Accessing the firstcloud API

A. Authenticated using "Keystone credentials" (user and password)

To work with the firstcloud API you need to set environment variables used by the command line tools to authenticate and authorize your API calls. Users logged into the Dashboard can download a file that helps setting these variables under API Access. There you can click on Download OpenStack RC File --> Openstack RC File (Identity API v3) to download the corresponding file.

fc-horizon-api-access

After downloading the file, we just need to source the variables and insert the password.

source Downloads/demo-openrc.sh

Sourcing this file to set up environment variables does not return output.

B. Authenticated using "firstcloud Identity Broker" (OpenID Federation)

Users who logged in via OpenID Federation must use a plugin to access their project. See OpenID Federation to see the full guide.

Test API Access

We can now use the OpenStack command line client to check whether our access works:

firstcolo:~ firstcolo$ openstack network list
+--------------------------------------+----------------+---------+
| ID                                   | Name           | Subnets |
+--------------------------------------+----------------+---------+
| 31e322e1-b017-4da7-a53c-3701ccb64da1 | fc-external-ha | ...     |
+--------------------------------------+----------------+---------+

In this example you see a network pool which provides us with Floating IP addresses. This shows that you successfully used the firstcloud API.