94628b791d
Updates the API documentation article for API keys to note that generating a new API key will logout the account from any mobile clients. Updates the API key modal in the web app with a similar note. We already note this in the help center article on protecting your account, which has a section about generating a new API key.
2.0 KiB
API keys
An API key is how a bot identifies itself to Zulip. For the official
clients, such as the Python bindings, we recommend downloading a zuliprc
file. This file
contains an API key and other necessary configuration values for using the
Zulip API with a specific account on a Zulip server.
Get API key
{start_tabs}
{tab|for-a-bot}
{settings_tab|your-bots}
-
In the Actions column, click the manage bot () icon, and scroll down to API key.
-
Click the copy () icon to copy the bot's API key to your clipboard.
!!! warn ""
Anyone with a bot's API key can impersonate the bot, so be careful with it!
{tab|for-yourself}
{settings_tab|account-and-privacy}
-
Under API key, click Manage your API key.
-
Enter your password, and click Get API key. If you don't know your password, click reset it and follow the instructions from there.
-
Copy your API key.
!!! warn ""
Anyone with your API key can impersonate you, so be doubly careful with it.
{end_tabs}
Invalidate an API key
To invalidate an existing API key, you have to generate a new key. Generating a new API key will immediately log you out of this account on all mobile devices.
{start_tabs}
{tab|for-a-bot}
{settings_tab|your-bots}
-
In the Actions column, click the manage bot () icon, and scroll down to API key.
-
Click the generate new API key () icon.
{tab|for-yourself}
{settings_tab|account-and-privacy}
-
Under API key, click Manage your API key.
-
Enter your password, and click Get API key. If you don't know your password, click reset it and follow the instructions from there.
-
Click Generate new API key
{end_tabs}