Skip to content

Commit

Permalink
Docs: update API V3 docs about authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
stsewd committed Aug 6, 2024
1 parent 494d847 commit b58ca2e
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions docs/user/api/v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Authentication and authorization
--------------------------------

Requests to the Read the Docs public API are for public and private information.
All endpoints require authentication.
Endpoints that return public information do not require authentication.


Token
Expand Down Expand Up @@ -45,16 +45,7 @@ to authenticate as a user and have the same permissions that the user itself.
Session
~~~~~~~

.. warning::

Authentication via session is not enabled yet.

Session authentication is allowed on very specific endpoints,
to allow hitting the API when reading documentation.

When a user is trying to authenticate via session,
:abbr:`CSRF (Cross-site request forgery)` check is performed.

Session authentication is allowed, so the API can be used by our dashboard and other internal services.

Resources
---------
Expand Down

0 comments on commit b58ca2e

Please sign in to comment.