khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 10:46:21 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11309 from nextcloud/oidc-api

Browse Source 
add documentation about authentication options
This commit is contained in:
Joas Schilling
2023-11-27 10:34:05 +01:00
committed by GitHub
parent 8340a191d8 50e912a20c
commit f51802f2e8
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
developer_manual/client_apis/OCS/ocs-api-overview.rst
View File

@@ -6,6 +6,24 @@ This document provides a quick overview of the OCS API endpoints supported in Ne
All requests need to provide authentication information, either as a Basic Auth header or by passing a set of valid session cookies, if not stated otherwise.
Authentication
--------------
Authentication can happen either via username / password (or app token) or with OIDC tokens, see the examples below:
Username/Password:
.. code-block:: bash
curl -u username:password -X GET 'https://cloud.example.com/ocs/v1.php/...' -H "OCS-APIRequest: true"
OIDC Token:
.. code-block:: bash
curl -X GET 'https://cloud.example.com/ocs/v1.php/...' -H "OCS-APIRequest: true" -H "Authorization: Bearer ID_TOKEN"
Testing requests with curl
--------------------------