API Key

  • 3 minute(s) read
Prev Next

Only administrators with an administrator role at the system or tenant level can see this page in nVoq Administrator. Tenant level administrators must have a role of Customer Administrator or Read-Only.  


On the API Key page System- or Tenant-level "Customer Administrators" can generate API keys to be used for automatic log in to a voice client using a single sign-on (SSO) solution or as a Windows signed-on user.

An API key is valid for ONE YEAR and the expiration date is displayed in the list view.
Expired API keys are deleted from the system and cannot be restored.
API Keys are for use with the nVoq API only. This functionality is NOT built-in to use with nVoq products.


API Key Page Toolbar

APIkey-toolbar

Delete Toolbar-Trash-icon

When one or more API keys in the list is selected using the checkmark to the left of the list, the trash can icon will appear in the toolbar. Click the trash can icon to delete the selected API keys. See Delete API Key

New Toolbar-Add-icon

Click on the plus symbol to create a new API key. See Add API Key

Download Toolbar-Download-icon

Click on the download icon to download a .csv file spreadsheet that includes all API keys shown in the list on the page, including the entire API key.

Support Center Toolbar-QuestionMark-icon

Click on the question mark icon in the blue bar to go directly to the online documentation for the API Key page. (The black question mark icon at the top right goes to the nVoq Administrator main help page.)

Search generic-search-field

Use the Search field near the top-right (in the gray area) to search for an API key by information in the any of the columns visible on the screen. Enter all or part of a word or name.

API Key Page Columns

The API keys listed on the page are filtered by the organization menu. All API keys at and below the organization selected in the menu are listed on the page. 

APIkey-columns

Click on any column header on the page to sort information in ascending or descending order. The sort order is retained after selecting a different organization in the organization menu. Additionally, sorting and scrolling location are remembered when leaving and returning to a page, even if you log out and back in. 
The list on this page can display up to 10,000 items. If you see an item count of 10,000 on a page, there may be more that are not included in the list. You could use Search or view a lower-level organization with less data to find specific items that may not be included in the list.

Person Icon / Checkbox

Hover your mouse over the person icon Account-icon and click to put a checkmark in the box to select the API key on that line in order to perform an action on it from the blue toolbar. Once selected, the row turns green and has a checkmark on the left.

  • You can select multiple API keys by clicking on each icon and then perform actions available from the icons in the blue toolbar on all selected API keys.
  • You can select all API keys in the list by putting a checkmark in the box on the left side of the column headers (above the person icons).

Name

The name that was given to the API key. By default, the list is sorted by names in this column.

Organization

The organization that uses the API key.

The list will include API keys for all organizations at and below the organization level selected in the organization menu at the top of the page.

Expiration Date

The date that the API key will expire, which is one (1) year from the creation date. An email will be sent to all administrators with a Customer Administrator role at the tenant level to notify them of upcoming API key expiration. Notifications are sent 30, 14, 7, 3, and 1 day before the API key expires. Be sure to create the new API key and update your application BEFORE this date so that users can continue to log in. After an API key expires it is deleted from the system and cannot be restored.

Created By

The username of the administrator that added the API key. 

Key

The API key sequence, truncated in the middle. You can view the full API key by going to the Edit API Key page (double-click on the API key item in the list or use the Actions menu). To download the full API key, click the Download icon in the toolbar. 

Actions

Click on the Actions iconAccounts-actions-iconto open a menu and select an action to take with the API key. Possible actions may include:

  • Edit API Key: Make changes to an API key. See Edit API Key
  • Copy Key to Clipboard: Copy the API key to your clipboard.
  • Delete: Remove an API key. See Delete API Key