Skip to content

Commit a4551e3

Browse files
committed
fixing documentation issues
This addresses documentation problems, the levels were incorrect as I did not understand what the next level should have been in the docs. I've also updated the usage documentation a little to be more useful.
1 parent 28483f9 commit a4551e3

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

docs/source/usage.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,30 @@ For providers configured with ``OIDCAuthenticator``, use provider-specific endpo
161161
under ``/api/auth/provider/<provider-name>/...``.
162162

163163
Browser-first flow
164-
~~~~~~~~~~~~~~~~~
164+
******************
165165

166166
If you are already in a browser context, open:
167167

168168
``<hostname>/api/auth/provider/<provider-name>/authorize``
169169

170170
This redirects to the OIDC provider login page and then back to the server callback.
171171

172+
This can similarly be acheived using ``httpie`` by opening the URL in a browser after getting
173+
the authorization URI from the server::
174+
175+
http POST http://localhost:60610/api/auth/provider/entra/authorize
176+
177+
Which will return a token back to the bluesky http server after the user logs in to the provider
178+
in their browser (or automatically if already logged in). The user then gets a token
179+
for the bluesky HTTP server to use for subsequent API requests. This flow can be used
180+
even when using the bluesky queueserver api in a terminal so long as that session can
181+
spawn a browser for the user to log in to the provider.
182+
172183
CLI/device flow
173-
~~~~~~~~~~~~~~~
184+
***************
174185

175-
For terminal clients, start with ``POST /api/auth/provider/<provider-name>/authorize``.
186+
For terminal clients (i.e. no browser possible), start with
187+
``POST /api/auth/provider/<provider-name>/authorize``.
176188
The response includes:
177189

178190
- ``authorization_uri``: open this URL in a browser

0 commit comments

Comments
 (0)