How do I create an API key?

Grant Pankonien — Tue, 04 Aug 2020 15:56:54 GMT

Current Revision posted to User Documentation by Grant Pankonien on 08/04/2020 15:56:54

[toc]

You can create an API key on your Settings > Options tab.

To support API, Telligent Community Server allows you to create keys to authenticate users for web service calls without requiring you to provide your user name and password to authorized applications.

API keys are generated per user. So before you generate a API key, make sure that you are logged in as the user who will be using the key:

If you are a registered user, you can go ahead and use the generation options on the tab.
If you are an admin who needs to generate a key for a user, you can do so while [[Impersonate a user|impersonating]] him/her.

Create an API key

Click your user avatar.
Click Settings. The Options tab appears.
Scroll down to API Keys.
Click Manage application API keys. The API key page appears.
Enter a name for the key.
Click Generate. The key is generated and listed in the API keys table.

Edit/rename or disable an API key

Click your user avatar.
Click Settings. The Options tab appears.
Scroll down to API Keys.
Click Manage application API keys. The API key page appears.
To edit a key, click Edit beside the key. To delete a key, click Delete. To regenerate it, click Regenerate.