Skip to main content

API & CLI Authentication Management

RapidPipeline automations require an Authentication Token, which connects your application to our licensing system.

Tokens can be generated from the web platform by active subscribers to the Pro plan or higher. The generation of Authentication Tokens is not available with the Starter plan.

There are two types of Tokens, which are not interchangeable:

  1. Integration Tokens are for the Integration Plugins, and are created and managed by Integrations Seat Management.

  2. API Tokens are for the API and CLI, and are created and managed by API & CLI Authentication Mangement.

Generating a Token for the API or CLI​

Create an API Token

  1. Login to https://app.rapidpipeline.com then click on your Account Profile in the top right corner, and select Auth Tokens.

  2. In the field where it says Token Name (required) type in some custom text.

  3. Click on Create Authentication Token.

  4. A popup window will appear, containing the new Token. Copy the generated Token.

    IMPORTANT

    Make sure to copy the token string, as it won’t be accessible through the web interface later, for security reasons.

  5. If using the CLI, insert the token string into rpd_account.json:

{
    "host" : "api.rapidcompact.com",
    "token" : "YOUR AUTH TOKEN HERE"
}
  1. If using the API or the rpdc.py scripting tool, insert the token string into credentials.json:
{
    "token" : "YOUR AUTH TOKEN HERE"
}

Token Status & Revocation​

You can always check the status of your Tokens and see if they are in recent use or not, by visiting the API Authentication Tokens and Desktop Seat Management pages in your dashboard.

If you decide to revoke a Token, keep in mind that revocation is terminal; you will not be able to recover the same exact Token that was revoked. However, revoking a Token frees up a slot, so simply create a new Token instead, and insert it into the desired application.

You can manually release one seat every 24 hours to assign a different machine. Seats are automatically released after 2 weeks of inactivity.

caution

After a seat is released, avoid processing or entering the respective token again on the machine which should not have the seat assigned anymore, as this will re-activate the seat again to the same machine and triggers the 24 hours seat release rate limit.

As an alternative you can re-issue a new token to generate a new seat for the new machine. In those cases we recommend to revoke the old token which should then not be in use anymore.

Multi-User​

One account in your organization can be used to share multiple Tokens with different teams, departments or individual users. The main administration tools will be managable only from the account which created the Tokens in the first place.

This approach works well using the CLI, API and Integration distributions of RapidPipeline, but will not work if multiple users want to access the same web portal account and interface. There is currently no multi-tenant system for the web platform.

There is no limitation on the number of available API Tokens, however the number of Integration Tokens may be limited per your license terms.