Skip to content

Commit

Permalink
Soullivaneuh bundle query params (#239)
Browse files Browse the repository at this point in the history
Documentation about query_param auth configuration
  • Loading branch information
dbu committed Jul 30, 2018
1 parent 8e85ac3 commit a1c5f30
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
7 changes: 6 additions & 1 deletion integrations/symfony-bundle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Authentication
``````````````

You can configure a client with authentication. Valid authentication types are
``basic``, ``bearer``, ``service`` and ``wsse``. See more examples at the
``basic``, ``bearer``, ``service``, ``wsse`` and ``query_param``. See more examples at the
:doc:`full configuration </integrations/symfony-full-configuration>`.

.. code-block:: yaml
Expand All @@ -288,6 +288,11 @@ You can configure a client with authentication. Valid authentication types are
factory: 'httplug.factory.guzzle6'
plugins: ['httplug.plugin.authentication.my_wsse']
.. warning::

Using query parameters for authentication is :ref:`not safe <Authentication-QueryParams>`.
The auth params will appear on the URL and we recommend to NOT log your request, especially on production side.

Special HTTP Clients
````````````````````

Expand Down
4 changes: 4 additions & 0 deletions integrations/symfony-full-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ This page shows an example of all configuration values provided by the bundle.
my_bearer:
type: 'bearer'
token: 'authentication_token_hash'
my_query_param:
type: 'query_param'
params:
access_token: '9zh987g86fg87gh978hg9g79'
my_service:
type: 'service'
service: 'my_authentication_service'
Expand Down
2 changes: 2 additions & 0 deletions message/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ WSSE
$authentication = new Wsse('username', 'password');
.. _Authentication-QueryParams:

Query Params
************

Expand Down

0 comments on commit a1c5f30

Please sign in to comment.