Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

These client credentials will not work with the legacy Vonage Contact Center APIs. For information about client credentials for legacy Vonage Contact Center APIs, see Getting your account key and API authentication token.

Depending on your license, you can perform different tasks in API Admin:

  • Create your own user-level credentials
  • View your own credentials
  • View all credentials (admin user only)
  • Edit your own user-level credentials
  • Edit account-level credentials (admin user only)
  • Delete your own credentials
  • Delete all credentials (admin user only)
Panel
titleColor#ffffff
titleBGColor#232323
titleIn this page

Table of Contents

How do I create new user-level API credentials?

Insert excerpt
_ExcerptClientCredentialsCreating
_ExcerptClientCredentialsCreating
nopaneltrue

How do I

...

view API credentials in my account?

Depending on your license, you can locate and view different API credentials:

  • If you are a supervisor user, when you go to API Admin only your own (user-level) API credentials appear. No one else's credentials appear.
  • If you are an admin user and your account contains no account-level API credentials, all user-level API credentials in your account appear. Use the Filter list to switch between viewing all credentials in your account (All Credentials) and your own credentials (My Credentials).
  • If you are an admin user and your account contains previously created account-level API credentials, two tabs appear: Users and Accounts. User-level credentials appear on the Users tab. Use the Filter list to switch between all credentials and your own credentials as described earlier. Account-level credentials appear on the Accounts tab.

Click to open and view individual API credentials.

How do I edit API credentials?

Insert excerpt
_ExcerptClientCredentialsEditing
_ExcerptClientCredentialsEditing
nopaneltrue

How do I delete API credentials?

Depending on your license, you can delete different API credentials. As a supervisor user, you can only delete your own user-level credentials; admin users can delete any API credentials.

If you no longer require particular API credentials, from API Credentials click the MenuImage Removed icon the trash can icon at the right of the API credentials you want to delete, and click Delete API credentials in the dialog box that appears.

Info
titleDeleting users
If a user has user-level API credentials, you cannot delete that user from User Admin. To delete a user, you must delete their API credentials first.

Configuring API credentials

...