Skip to content

Commit

Permalink
Merge pull request #132 from higlass/pkerpedjiev/docs-update-1
Browse files Browse the repository at this point in the history
Added docs on passing in an auth header
  • Loading branch information
pkerpedjiev authored Aug 24, 2023
2 parents a74443f + bcd82d6 commit 91ab3db
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
Examples
########

Passing in an auth token
------------------------

If the source higlass server requires authentication, an auth token
can be passed in to the `Authorization` header of the request. To do
this, the viewer needs to be instantiated as a widget with the
contents of the authorization header passed in.

.. code-block:: python
from higlass import view
v1 = view(...)
v1.widget(authToken=f"Bearer <my_token>")
Synchronizing location, zoom and value scales
---------------------------------------------

Expand Down

0 comments on commit 91ab3db

Please sign in to comment.