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

Docs: update API V3 docs about authentication #11517

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Docs: update API V3 docs about authentication #11517

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
13 changes: 2 additions & 11 deletions docs/user/api/v3.rst
View file
Open in desktop
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
Loading