Merge pull request #5359 from owncloud/docs-api-auth

[docs-only] graph api authentication, edit link fixes
This commit is contained in:
Michael Barz authored and GitHub committed 2023-01-09 15:55:38 +01:00
commit 2489b67562
4 files changed
+10 -4

No files matched your search

+6
View File
@@ -61,6 +61,12 @@ GET https://ocis.url/graph/v1.0/drives?$filter=driveType eq 'project'
```
For more information about OData query options please check the [API specification](https://github.com/owncloud/libre-graph-api) and the provided examples.
### Authorization
For development purposes the examples in the developer documentation use Basic Auth. It is disabled by default and should only be enabled by setting `PROXY_ENABLE_BASIC_AUTH` in [the proxy](../../../services/proxy/configuration/#environment-variables) for development or test instances.
To authenticate with a Bearer token or OpenID Connect access token replace the `-u user:password` Basic Auth option of curl with a `-H 'Authorization: Bearer <token>'` header. A `<token>` can be obtained by copying it from a request in the browser, although it will time out within minutes. To automatically refresh the OpenID Connect access token an ssh-agent like solution like [oidc-agent](https://github.com/indigo-dc/oidc-agent) should be used. The graph endpoints that support a preconfigured token can be found in the [API specification](https://github.com/owncloud/libre-graph-api)
## Resources
{{< toc-tree >}}
+2 -2
View File
@@ -2,8 +2,8 @@
title: Groups
weight: 40
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/graph
geekdocFilePath: users.md
geekdocEditPath: edit/master/docs/apis/http/graph
geekdocFilePath: groups.md
---
{{< toc >}}
+1 -1
View File
@@ -2,7 +2,7 @@
title: Spaces
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/graph
geekdocEditPath: edit/master/docs/apis/http/graph
geekdocFilePath: spaces.md
---
+1 -1
View File
@@ -2,7 +2,7 @@
title: Users
weight: 30
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/graph
geekdocEditPath: edit/master/docs/apis/http/graph
geekdocFilePath: users.md
---