BarTender Cloud API Page

In the Administration section of the BarTender Cloud menu, click API Keys, to open the BarTender Cloud API page. This page provides secure ways to make API calls to your account, manage integraion access, and generate access tokens.

The following options are available:

  • Register for OAuth Access: The recommended access protocol for web-based applications. Available on the Web Applications (OAuth) panel.

  • Register Application for Password-Based Access: Required when your application cannot present the BarTender Cloud login interface to users. Available on the Console Applications and Services (Password-Based) panel

  • Register Machine-to-Machine Application: Used for server-to-server integrations that do not require user interaction. Available on the Machine-to-Machine (Client Credentials) panel.

  • : Displays the column chooser list so that you can select the columns that you want to be displayed in the table. The following options are available:

    • Hide All: Hides all columns except the Application Name column, which is always displayed by default.

    • Show All: Shows all columns.

    • Application Name: Shows the Application Name column in the table. This option is enabled by default and cannot be changed.

    • Created: Shows the Created column, which displays the date the application was created.

    • Auth Type: Shows the Auth Type column, which displays the type of authorization used by the application.

    • Modified: Shows the Modified column, which displays the date the application was last modified.

    • Creator: Shows the Creator column, which displays the name of the person who created the application.

    • Description: Shows the Description column, which displays the value entered into the Description field when creating or modifying the application.

    • Associated Service Account: Shows the Associated Service Account column. If you assigned a Service Account to this application, the account is displayed here.

    • Token Lifetime: Shows the Token Lifetime column, which displays the maximum time in minutes the application can run before a new authorization token is required.

    • Application ID: Shows the Application ID column, which displays the ID created for the application when it was itself created. Click to copy the ID to the clipboard.

  • : Displays the following options:

    • Edit: Opens the Edit Web Application Registration, Edit Password-Based Access, or Edit M2M Application dialog for the selected application so that you can make edits as needed.

    • Delete: Opens the Delete Application Registration or Delete M2M Application dialog so that you can delete the selected application.

    • View ID & Secret: Displays the application ID and secret for the selected application.

    • View Client ID: Displays the client ID for the selected application. Only available for M2M applications.

    • Regenerate Client Secret: Creates a new client secret, then displays the application's client ID and secret.Only available for M2M applications.

    • Disable/Enable: Changes the application's status to Disabled or Active. A disabled application prevents any associated service account from generating new access tokens.Only available for M2M applications.

  • View Access Token: Opens the Personal Access Token dialog where you can copy or refresh the BarTender Cloud API access token.

Related topics