Skip to content

Commit

Permalink
Merge pull request #3962 from open-formulieren/docs/3735-update-outda…
Browse files Browse the repository at this point in the history
…ted-section

Update documentation about pre-request clients
  • Loading branch information
SilviaAmAm authored Mar 4, 2024
2 parents 55074bf + a2cdb83 commit 1cd8608
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/developers/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
Extensions
==========

Official extensions maintained by the Open Forms core developers.

Keycloak token exchange extension
=================================

Expand Down Expand Up @@ -39,9 +41,11 @@ The flow works as follows:

#. Open Forms requests prefill data from Haal Centraal:

* The client that makes the request to the ZGW API is :class:`openforms.pre_requests.clients.PreRequestZGWClient`.
This client is a subclass of :class:`zgw_consumers.client.ZGWClient` which overrides the ``pre_request`` method so
that any pre-request hooks registered in Open Forms are run before performing the request.
* Prefill data is retrieved using the client
:class:`openforms.contrib.haal_centraal.clients.brp.BRPClient`, which makes use of
the pre-request hooks through :class:`openforms.pre_requests.clients.PreRequestMixin`.
It intercepts the :mod:`requests` request preparation to modify the request before
it's actually sent out over the network.
* The ``open-forms-ext-token-exchange`` extension registers a pre-request hook which adds a
`custom authentication class`_ to the request.
* The custom authentication class ``token_exchange.auth.TokenAccessAuth`` checks if the URL to which the
Expand Down

0 comments on commit 1cd8608

Please sign in to comment.