API Tokens

All operations in a KBC project must be authorized. This is technically done using API tokens (also called Storage API tokens, SAPI tokens, and Storage tokens).

KBC is built using the API-first approach; almost every operation done in KBC is in fact an API call and uses an API token. A token is valid only within a single project (hence the name Storage API token).

Apart from API tokens, there are also management tokens, which are used to perform operations outside individual projects.

Normally, when you are using the user interface, your API token is exchanged automatically with the server backend. Therefore you need to work with tokens only when working with KBC programmatically (or if you need to limit a user’s authorization to certain operations or data). To learn more about all the available programmatic approaches, please follow our developers documentation.

Tokens can be managed from the Users & SettingsAPI Tokens page.

Screenshot - Storage Tokens

Master Tokens

Tokens that belong to project administrators are called master tokens. Their description is the email of the user they belong to. Master tokens cannot be modified, shared or deleted. The only way to delete a master token is by removing the user from the project on the Users & SettingsUsers page.

A single user has only a single master token. In addition, master tokens are the only ones which can be used to create other tokens. A master token has always access to all components, so having it allows you to do everything that can be otherwise done via the KBC Administration UI.

Working with Tokens

API tokens are created

  1. automatically when joining a project (master token).
  2. automatically when creating a new configuration of certain components (for example, Orchestrations).
  3. manually when needed.

Typical reasons to manually create a new API token are:

  • You want to use the APIs; this includes all of the Storage clients.
  • You need to limit access to certain data (for example, share a single table) or components.

Although tokens cannot be used to directly login to the KBC UI, they do allow executing almost all operations in a KBC project. As such, they must be treated as secret. Therefore the token string is shown only when the token is created and it is not accessible later. You should immediately refresh a token in case there is a suspicion that the token string was revealed to unauthorized persons.

When creating a new token, the following rules apply:

  • Tokens by default give no access to any of the KBC components.
  • Token bearers can only access permitted Storage buckets via the Storage API or Storage console.
  • Tokens cannot be used to run any actions in your project.
  • Tokens cannot be used to create other tokens (only a master token can be used to create new tokens).

You should never share the same token in multiple applications. The number of tokens is not limited in any way, neither are any charges associated with them. Therefore, every time you need to provide someone with a KBC token, create a new one.

Token Events

KBC also tracks all operations performed by each token. You can view the list of events from the token detail page. Click on the token you are interested in:

Screenshot - Token List

In the Events tab, you can see all operations performed by that token:

Screenshot - Token List

Note: History of token operations is kept for 6 months. If you are interested in events associated with a particular storage object, view the events in Storage.

Limited Tokens

To add users with access limited to only some of your data, create a new token:

Screenshot - Access Tokens

Limit access of that token to a single Storage bucket, for instance, ‘in.c-csv-import’. You can also limit the token validity.

Screenshot - Access Tokens

You can see and copy the token only once — right after it was created. If you need to access the token later, you can share it.

Screenshot - Access Tokens

Token details can be accessed and updated on the token detail page anytime.

Screenshot - Access Tokens

Limited Access to Components

For production use, it is recommended not to give away your master token but to create dedicated tokens for different uses. This also simplifies refreshing tokens as it is clear for what each token is used.

For example, suppose that you need to trigger data extraction from a MySQL database from within your own environment. You would then create a token which is authorized for running the MySQL database extractor (keboola.ex-db-mysql component) and write access to the in.c-csv-import bucket (which is used as a destination in the particular configuration you want to run).

Screenshot - Component limited token

You can then share the token to the person responsible for the database process and be sure that they can use only that particular component in that particular bucket. They will be even able to reconfigure it — e.g., update the extraction queries (but only via the API). Also, writing to a limited set of buckets is a good way of preventing accidentally overwriting data.

Refreshing a Token

Every token can be refreshed: a new token value (token string) is generated, and the old token becomes immediately invalid. That means you have to update all places where the token was used. If you invalidate your own master token, you have to reload your KBC view in the browser.

Screenshot - Refresh Token Button

A confirmation dialog is displayed. When you click Refresh, the old token will become invalid.

Screenshot - Refresh Token Detail

A new token is generated. Now you can copy it or send it to someone.

Screenshot - Refresh Token Done

Sharing a Token

An existing token can be shared to an arbitrary email address (including yours). You can share a token by clicking the Send token button. Note that master tokens cannot be shared.

Important: Always use the Send token feature instead of copying and sending the token yourself. This is more secure because it does not actually send the token, only a link to retrieve it.

Screenshot - Access Tokens

A message can be added to the email.

Screenshot - Send Token

The recipient will obtain an email with an invitation link leading to the following screen:

Screenshot - Token Welcome Screen

Only the buckets you made accessible will be accessible by the token. If you set the token to expire, it will get deleted automatically after the specified period. In addition to sharing sections of your data with selected users, the buckets can be also used for writing; people can send data directly to your KBC project instead of struggling with FTP or e-mail attachments. To revoke the access, simply delete the token.

The token can then be used with the Storage API or other APIs. It is also possible to use the Storage console to upload or download tables or files to the project.

Screenshot - Storage Console