zulip/api_docs/include/curl-auth-credentials.md
Lauryn Menard 47a4d8900d api-docs: Update placeholder for curl user basic auth credentials.
Updates the placeholder in the curl examples of the API docs for
the user authentication line (-u) to be EMAIL_ADDRESS:API_KEY.

Adds text to the top of the curl tab about the user authentication
line with links to the curl man doc and the authorization header
section of the HTTP headers article.

If the endpoint does not have the user auth line (e.g., fetching
an API key in dev and production), then the text is not added to
the curl tab.

Fixes #479.
2026-02-26 10:18:12 -08:00

307 B

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.