Skip to content

Commit 000b026

Browse files
ElienVandermaesenVITOsoxofaan
authored andcommitted
issue #685 place main section together with configs
1 parent f0fa032 commit 000b026

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

docs/auth.rst

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ General options
7575

7676
* A back-end might support **multiple OpenID Connect providers**.
7777
The openEO Python Client Library will pick the first one by default,
78-
but another another provider can specified explicity with the ``provider_id`` argument, e.g.:
78+
but another another provider can specified explicitly with the ``provider_id`` argument, e.g.:
7979

8080
.. code-block:: python
8181
@@ -300,30 +300,6 @@ For example:
300300
>>> connection.authenticate_oidc()
301301
<Connection to 'https://openeo.example.com/openeo/1.1/' with OidcBearerAuth>
302302
303-
Basic HTTP Auth
304-
===============
305-
306-
The easiest authentication method is
307-
based on the Basic HTTP authentication scheme.
308-
It is however *not recommended* for various reasons,
309-
such as its limited *security* measures.
310-
For example, if you are connecting to a back-end with a ``http://`` URL
311-
instead of a ``https://`` one, you should certainly not use basic HTTP auth.
312-
313-
With these security related caveats out of the way, you authenticate
314-
using your username and password like this::
315-
316-
connection.authenticate_basic("john", "j0hn123")
317-
318-
Subsequent usage of the connection object ``connection`` will
319-
use authenticated calls.
320-
For example, show information about the authenticated user::
321-
322-
>>> connection.describe_account()
323-
{'user_id': 'john'}
324-
325-
326-
327303
328304
329305
@@ -451,6 +427,32 @@ For example::
451427
452428
453429
430+
431+
Basic HTTP Auth
432+
===============
433+
434+
The easiest authentication method is
435+
based on the Basic HTTP authentication scheme.
436+
It is however *not recommended* for various reasons,
437+
such as its limited *security* measures.
438+
For example, if you are connecting to a back-end with a ``http://`` URL
439+
instead of a ``https://`` one, you should certainly not use basic HTTP auth.
440+
441+
With these security related caveats out of the way, you authenticate
442+
using your username and password like this::
443+
444+
connection.authenticate_basic("john", "j0hn123")
445+
446+
Subsequent usage of the connection object ``connection`` will
447+
use authenticated calls.
448+
For example, show information about the authenticated user::
449+
450+
>>> connection.describe_account()
451+
{'user_id': 'john'}
452+
453+
454+
455+
454456
Basic HTTP Auth config
455457
-----------------------
456458

0 commit comments

Comments
 (0)