Admin: Add API Key
  • 1 Minute to read
  • Dark
    Light

Admin: Add API Key

  • Dark
    Light

Article Summary

Create a new API key to be used for automatic log in to a voice client using single sign-on.

 

  1. Go to the API Key page in nVoq.Administrator.

  2. Click the New icon (Toolbar-Add-icon) in the blue toolbar to go to the Add API Key page.

  3. Type a name for the API key in the Name field.
    APIkey-add-name

  4. From the Organization menu, select the organization that should be able to log in with this key.
    • Optionally use the Filter field at the top of the organization menu to find a specific organization in the list.
      APIkey-add-organization

  5. Click the Save button.
    APIkey-add-save

  6. You will be taken back to the list view and your new key will be listed on the page.
    Your new API key is valid for one year, and the expiration date is displayed in the list view. Be sure to create new API keys and update your application BEFORE this date so that users can continue to log in.
    After API keys expire they are deleted from the system by a job that runs each day. Deleted API keys cannot be restored. 
    APIkey-add-success
  7.