User Tokens

A User Token in Workbench is a unique identifier used to authenticate a user for programmatic access via API or Extractor Studio CLI.

Currently there is no user interface within the Workbench application which allows the creation or viewing of User Tokens. For now you have to use the API.

Important Note

Although all User Token APIs require the presence of a "org slug" in the path, though the Org Slug must be valid it is irrelevant.

User Tokens are tied to the user, not the Organization

A future version of Workbench will remove "org slug" from these APIs

Creating a User Token

Documentation for the API used to create a UserToken is found at https://workbench.import.io/api/docs/#/UserToken/post_api_orgsorgSlugusertokens[this page]

Here are two convienent ways to create a User Token

cURL

Use the following request in your terminal, sub out the variables accordingly. "org_slug" is defined as any valid org slug from an Organization you belong to.

curl -X POST "https://workbench.import.io/api/orgs/<org_slug>/usertokens?_apikey=< API Key from https://app.import.io/dash/account/settings >" \
-H  "accept: application/json" -H  "Content-Type: application/json" \
-d "{  \"name\": \"My User Token\",  \"userId\": \"< your user id from https://workbench.import.io/users >\"}"

Swagger

{
  "name": "My User Token",
  "userId": "<your workench user id>" // Found at https://workbench.import.io/users
}
  • Enter any valid org slug of an Organization you belong to for the orgSlug section

  • Click "Execute"

  • If successful, newly created User Token will be in the response

Viewing your Tokens

You can view your tokens by visiting the API:

Again the Org Slug is irrelevant, just use the slug of an Org you belong to.

Using your Token

You can use your User Token for programmatic access via API or Extractor Studio CLI

API

To use your User Token with the Workbench API simply include an Authorization header with the value UserToken <your user token> for every request.

API documentation available at https://workbench.import.io/api/docs

CLI

To use your User Token with the Extractor Studio CLI simply enter the following command and enter your User Token when prompted:

import-io config

The User Token is used when deploying and editing Sources from an extractor library, using the import-io source:deploy: commands.