CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-03 21:10:12 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
544e472ec3
zulip/templates/zerver/api/api-keys.md
sahil839 0c80d23857 help: Update help pages according to profile page redesign. 
This commit fixes the documentation of settings as we have
replaced "Your account" section into two new sections -
"Profile" and "Account & privacy".

This commit also fixes a comment in the test for settings
documentation in test_middleware.py.
2021-06-30 16:56:03 -07:00

932 B
Raw Blame History

API keys

An API key is how a bot identifies itself to Zulip. Anyone with a bot's API key can impersonate the bot, so be careful with it!

Get a bot's API key

{settings_tab|your-bots}

  1. Click Active bots.

  2. Find your bot. The bot's API key is under API KEY.

Get your API key

Anyone with your API key can impersonate you, so be doubly careful with it.

{settings_tab|account-and-privacy}

  1. Under API key, click Show/change your API key.

  2. Enter your password, and click Get API key. If you never had a password, click Never had one? Forgotten it? and follow the instructions from there.

  3. Copy your API key.

Invalidate an API key

To invalidate a key, follow the instructions above, and click Generate new API key or click the refresh () icon as appropriate.

This will generate a new key for you or the bot, and invalidate the old one.