Skip to content

Make important paragraph a more prominent by making it a note #866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kami merged 2 commits into from
Mar 13, 2019
Merged

Make important paragraph a more prominent by making it a note #866

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
224b054
Make that paragraph a note.
Kami Mar 13, 2019
4c280b0
Reword it.
Kami Mar 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/source/authentication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,8 +341,11 @@ third party service to integrate with |st2| and this service doesn't allow you t
headers), you can provide it as a query parameter named ``x-auth-token`` and ``st2-api-key``
respectively.

Keep in mind that using HTTP header is preferred since some web servers and third party services
log query parameters which are sent with each request, which could be a security risk.
.. note::

Keep in mind that using HTTP header is preferred since some web servers and third party services
log query parameters which are sent with each request. This could lead to auth token / api key
exposure and potentially pose a security risk.

Here's some examples of how to send authentication token and API key in the headers, and as a query
parameter using ``curl``:
Expand Down