Skip to main content

API Token (Legacy)

warning

API tokens are the legacy method of authentication for API requests. Existing API tokens will continue to work, but shouldn't be used for new API requests. Use OAuth client credentials instead.

API Tokens​

An API token is a static key tied to a specific Orgvue user account.

Any API request made with that token acts on behalf of that user and inherits their permissions.

API tokens are simple to set up as users generate them directly from their account.

But their simplicity comes with limitations: they're long-lived, don't expire automatically, and are permanently invalidated if the associated user account is deactivated or deleted.

Enable token access for your Orgvue account​

We use tokens to control authentication and access to the API.

These are unique credentials assigned to individual users. You can enable token access for your Orgvue account by following these steps:

ServerOrgvue Settings Url
EU Westhttps://orgvue.eu-west-1.concentra.io/app/configui
US Easthttps://orgvue.us-east-1.concentra.io/app/configui
AP SouthEasthttps://orgvue.ap-southeast-2.concentra.io/app/configui
EU West - Staginghttps://orgvue-staging.eu-west-1.concentra.io/app/configui
US East - Staginghttps://orgvue-staging.us-east-1.concentra.io/app/configui
AP SouthEast - Staginghttps://orgvue-staging.ap-southeast-2.concentra.io/app/configui
  1. Head to the Orgvue settings app for your server environment listed in the above table
  2. Navigate to the Users List:

  1. Select your user account and click on the Edit button.
  2. Make sure TokenAccess is enabled for your account:

  1. Remember to save your changes.

TokenAccess is a standard property for the Users List in all new Tenants, but may need to be added by an admin for existing Tenants. Note that the TokenAccess key is case-sensitive, so must be created as shown.

Produce a token for your network address​

To create an API token:

Token Management Image

ServerTokens Management Url
EU Westhttps://orgvue.eu-west-1.concentra.io/tokens
US Easthttps://orgvue.us-east-1.concentra.io/tokens
AP SouthEasthttps://orgvue.ap-southeast-2.concentra.io/tokens
EU West - Staginghttps://orgvue-staging.eu-west-1.concentra.io/tokens
US East - Staginghttps://orgvue-staging.us-east-1.concentra.io/tokens
AP SouthEast - Staginghttps://orgvue-staging.ap-southeast-2.concentra.io/tokens
  1. Go to the token management page for your server environment listed in the above table
  2. Provide the start and end dates for your new token.
  3. Set the Subnets field, which controls the range of IP addresses from which the generated token can be used, to your current IP address to restrict use of the token to your current network location. Dynamic IP ranges may be entered as a comma separated list of Classless Inter Domain Routing(CIDR) ranges
  4. Your current IP address will be displayed for information
  5. Create your token, and make sure to copy it as you will not be able to view it again.
info

IP access restrictions​

When accessing data stored in Orgvue, your account, tenant or token may be subject to restrictions around the originating source IP address.

If your attempt to access data is forbidden by an IP restriction access policy, you will receive an error message: