Skip to content
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

Added docs on passing in an auth header #132

Merged
merged 1 commit into from
Aug 24, 2023
Merged

Added docs on passing in an auth header #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/examples.rst
View file
Open in desktop
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