Access Tokens

An access token is an object that includes authorisation data that enables an application to access an API.

For the API Platform, an access token is always used alongside an app and it is only obligatory in a request if the API it accesses is configured so as to require Access Token Validation.

As one app can be linked to more than one API, through different plans, a given access token can be used to access different APIS.

List of access tokens

The screen for viewing and registering access tokens is accessed via the Main menu > Consumers  Access Tokens, as illustrated below:

access tokens

On this screen, you can view the existing tokens via a list containing the following details:

  • Code

  • Owner

  • Linked App

  • Status (active, expired or revoked)

  • Date created

In the Actions column are the Edit icon edit new and Overview icon overview buttons that allow you to edit a token or view more information about it (APIs and Plans).

Filtering access tokens

At the top of the screen there are three search fields. By clicking on the button Advanced filter you will see additional fields that allow you to filter the access tokens by:

  • API

  • Code

  • Owner

  • Creation date and expiry date

  • Status

  • Refresh Tokens

  • Refresh Status

Once you have entered the desired filters, just click on the button Search to perform the search, or you can clear it with the button Clear.

To preserve the filters applied to the list, you can open the tokens you want in a new tab or window. In the token title, there are 4 ways to do this:

  • Right-clicking to open in a new tab or window;

  • Pressing Ctrl+click to open in a new tab;

  • Pressing Shift+click to open in a new window;

  • Clicking with the mouse scroll to open in a new window.

The API and App search fields allow multiple selection. This means that you can search by entering more than one API and/or App at the same time.

  • Within the same field, the operator used is the "OR" type, any of the conditions must be met for a record to be selected.

    • If you search, for two APIs (API1 and API2), the result will bring all Access Tokens of API1 and API2. The same is true for searches by more than one App.

  • Between fields, the operator used is the "AND" type, all conditions must be met for a record to be selected.

    • If you search for API1 and API2 and also App1, the result will show all Access Tokens which are linked to APP1, whether they are from API1 or API2.

    • If you search for API1 and API2 and also APP1 and App2, the result will show all Access Tokens that have a link to App1 or App2, whether they are from API1 or API2.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]