Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/api_docs/api-keys.md

35 lines
916 B
Markdown
Raw Normal View History

/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
# API keys
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
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!
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
## Get a bot's API key
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
{settings_tab|your-bots}
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
1. Click **Active bots**.
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
1. Find your bot. The bot's API key is under **API KEY**.
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
## Get your API key
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
Anyone with your API key can impersonate you, so be doubly careful with it.
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
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-28 19:23:45 +02:00
{settings_tab|account-and-privacy}
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
1. Under **API key**, click **Show/change your API key**.
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
settings: Improve wording of "Show API key" modal. This commit changes the "Show API key" modal to use a more intuitive description of the user's password field, and also to put the reset password option, which should be the less common case, at the end. Fixes: #24506.
2023-03-09 03:48:37 +01:00
1. Enter your password, and click **Get API key**. If you don't know your
password, click **reset it** and follow the
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
instructions from there.
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
api docs: Update api-keys.
2018-09-26 06:02:58 +02:00
1. 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**
(<i class="fa fa-refresh"></i>) icon as appropriate.
This will generate a new key for you or the bot, and invalidate the old one.