Skip to main content
Version: Next

Tutorial

In this tutorial, we'll step through examples to highlight the capabilities of the Administration API, such as viewing your existing clients, creating a client, viewing a particular client's details, and deleting a client.

Prerequisites​

  • If you haven't done so already, create a cluster.
  • Upon cluster creation, create your first client by navigating to Console > Organization > Administration API > Create new credentials. Ensure you determine the scoped access for client credentials. For example, in this tutorial we will get, create, and delete a client. Ensure you check all the boxes for Zeebe client scopes.
note

Make sure you keep the generated client credentials in a safe place. The Client secret will not be shown again. For your convenience, you can also download the client information to your computer.

  • In this tutorial, we utilize a JavaScript-written GitHub repository to write and run requests. Clone this repo before getting started.
  • Ensure you have Node.js installed as this will be used for methods that can be called by the CLI (outlined later in this guide). Run npm install to ensure you have updated dependencies.

Getting started​

  • A detailed API description can be found here via Swagger. With a valid access token, this offers an interactive API experience against your Camunda 8 cluster.
  • You need authentication to access the API endpoints. Find more information here.

Set up authentication​

If you're interested in how we use a library to handle auth for our code, or to get started, examine the auth.js file in the GitHub repository. This file contains a function named getAccessToken which executes an OAuth 2.0 protocol to retrieve authentication credentials based on your client ID and client secret. Then, we return the actual token that can be passed as an authorization header in each request.

To set up your credentials, create an .env file which will be protected by the .gitignore file. You will need to add your CLUSTER_ID, ADMINISTRATION_CLIENT_ID, ADMINISTRATION_CLIENT_SECRET, ADMINISTRATION_AUDIENCE, which is api.cloud.camunda.io in a Camunda 8 SaaS environment, and ADMINISTRATION_API_URL, which is https://api.cloud.camunda.io.

These keys will be consumed by the auth.js file to execute the OAuth protocol, and should be saved when you generate your client credentials in prerequisites.

Can't find your environment variables?

When you create new client credentials as a prerequisite, your environment variables appear in a pop-up window. Your environment variables may appear as CAMUNDA_CONSOLE_CLIENT_ID, CAMUNDA_CONSOLE_CLIENT_SECRET, CAMUNDA_CONSOLE_OAUTH_AUDIENCE, and CAMUNDA_CONSOLE_BASE_URL. Locate your CLUSTER_ID in Console by navigating to Clusters. Scroll down and copy your Cluster Id under Cluster Details.

Examine the existing .env.example file for an example of how your .env file should look upon completion. Do not place your credentials in the .env.example file, as this example file is not protected by the .gitignore.

note

In this tutorial, we will execute arguments to view, create, and delete clients. You can examine the framework for processing these arguments in the cli.js file before getting started.

GET a list of existing clients​

First, let's script an API call to list our existing clients.

To do this, take the following steps:

  1. In the file named administration.js, outline the authentication and authorization configuration in the first few lines. This will pull in your .env variables to obtain an access token before making any API calls:
const authorizationConfiguration = {
  clientId: process.env.ADMINISTRATION_CLIENT_ID,
  clientSecret: process.env.ADMINISTRATION_CLIENT_SECRET,
  audience: process.env.ADMINISTRATION_AUDIENCE,
};
  1. Examine the function async function listClients() below this configuration. This is where you will script out your API call.
  2. Within the function, you must first apply an access token for this request, so your function should now look like the following:
async function listClients() {
  const accessToken = await getAccessToken(authorizationConfiguration);
}
  1. As noted in the detailed API description in Swagger, you must call your Administration API URL and cluster ID. Using your generated client credentials from prerequisites, capture your Administration API URL and cluster ID beneath your call for an access token by defining administrationApiUrl and clusterId:
const administrationApiUrl = process.env.ADMINISTRATION_API_URL;
const clusterId = process.env.CLUSTER_ID;
  1. On the next line, script the API endpoint to list your existing clients for a particular cluster:
const url = `${administrationApiUrl}/clusters/${clusterId}/clients`;
  1. Configure your GET request to the appropriate endpoint, including an authorization header based on the previously acquired accessToken:
const options = {
  method: "GET",
  url,
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${accessToken}`,
  },
};
  1. Call the clients' endpoint, process the results from the API call, emit the clients to output, and emit an error message from the server if necessary:
try {
  // Call the clients endpoint.
  const response = await axios(options);

  // Process the results from the API call.
  const results = response.data;

  // Emit clients to output.
  results.forEach((x) => console.log(`Name: ${x.name}; ID: ${x.clientId}`));
} catch (error) {
  // Emit an error from the server.
  console.error(error.message);
}
  1. In your terminal, run npm run cli admin list for a list of your existing clients.
note

This list command is connected to the listClients function at the bottom of the administration.js file, and executed by the cli.js file. While we will view, create, and delete clients in this tutorial, you may add additional arguments depending on the API calls you would like to make.

If you have any existing clients, the Name: {name}; ID: {Id} will now output. If you have an invalid API name or action name, or no arguments provided, or improper/insufficient credentials configured, an error message will output as outlined in the cli.js file.

POST a client​

To create a new client, you will follow similar steps as outlined in your [GET request] (#get-clientid) above:

  1. Edit the addClient function, incorporate the access token, and add your settings in the .env file. Note that this function destructures the clientName as the first item in an array passed in.
async function addClient([clientName]) {
  const accessToken = await getAccessToken(authorizationConfiguration);

  const administrationApiUrl = process.env.ADMINISTRATION_API_URL;
  const clusterId = process.env.CLUSTER_ID;
  1. Adjust your API endpoint to add a new client to a cluster:
const url = `${administrationApiUrl}/clusters/${clusterId}/clients`;
  1. When configuring your API call, issue a POST request, and add a body containing information for the new client:
const options = {
  method: "POST",
  url,
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${accessToken}`,
  },
  data: {
    clientName: clientName,
  },
};
  1. Call the add endpoint and process the results from the API call:
const response = await axios(options);
const newClient = response.data;
  1. Emit the new client to output. While different from this example, you will likely want to capture the clientSecret property from the response, as this cannot be displayed again:
console.log(
      `Client added! Name: ${newClient.name}. ID: ${newClient.clientId}.`
    );
  } catch (error) {
    // Emit an error from the server.
    console.error(error.message);
  }
  1. In your terminal, run npm run cli admin add <client name>, where <client name> is where you can paste the name of your new client.

GET a client ID​

To get a client ID, take the following steps:

  1. Outline your function, similar to the steps above:
async function viewClient([clientId]) {
  const accessToken = await getAccessToken(authorizationConfiguration);

  const administrationApiUrl = process.env.ADMINISTRATION_API_URL;
  const clusterId = process.env.CLUSTER_ID;
  1. Write the API endpoint to view a single client within a cluster:
const url = `${administrationApiUrl}/clusters/${clusterId}/clients/${clientId}`;
  1. Call the client endpoint using a GET method:
var options = {
  method: "GET",
  url,
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${accessToken}`,
  },
};
  1. Process your results from the API call and emit the client details:
try {
  const response = await axios(options);

  const clientResponse = response.data;

  console.log("Client:", clientResponse);
} catch (error) {
  console.error(error.message);
}
  1. In your terminal, run npm run cli admin view to view your client.

DELETE a client​

To delete a client, take the following steps:

  1. Outline your function, similar to the steps above:
async function deleteClient([clientId]) {
  const accessToken = await getAccessToken(authorizationConfiguration);

  const administrationApiUrl = process.env.ADMINISTRATION_API_URL;
  const clusterId = process.env.CLUSTER_ID;

  const url = `${administrationApiUrl}/clusters/${clusterId}/clients/${clientId}`;
}
  1. Configure the API call using the DELETE method:
var options = {
  method: "DELETE",
  url,
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${accessToken}`,
  },
};
  1. Process the results from the API call. For example:
try {
  const response = await axios(options);

  if (response.status === 204) {
    console.log(`Client ${clientId} was deleted!`);
  } else {
    console.error("Unable to delete client!");
  }
} catch (error) {
  console.error(error.message);
}
  1. In your terminal, run npm run cli admin delete <client ID>, where <client ID> is where you can paste the ID of the client you would like to delete.

If you get stuck​

Having trouble configuring your API calls or want to examine an example of the completed tutorial? Navigate to the completed folder in the GitHub repository, where you can view an example administration.js file.

Next steps​

You can script several additional API calls as outlined in the Administration API reference material.