-
Notifications
You must be signed in to change notification settings - Fork 189
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.
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-only]Document ocis as a IDP #7452
Conversation
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes. |
@amrita-shrestha if you agree on the changes of @EParzefall you can go into the Files-Changed view (on top), click to add suggestions to a batch and then click commit which creates one commit for all changes. |
docs/apis/http/oidc/_index.md
Outdated
--- | ||
title: "OIDC" | ||
date: 2023-10-10T00:00:00+00:00 | ||
weight: 21 | ||
geekdocRepo: https://github.com/owncloud/ocis | ||
geekdocEditPath: edit/master/docs/apis/http/idp | ||
geekdocFilePath: _index.md | ||
geekdocCollapseSection: true | ||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it go under apis
or clients
section?
CC @mmattel
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me, neither.
IMHO this should go as a new section named OIDC
into: https://owncloud.dev/ocis/identity-provider/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I would be a developer looking for how to integrate my app with oCIS I would first look into API->Authentication and expect there a description about how to get myself tokens etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as just discussed in the meeting, let's put
- the general overview (currently contained in
_index.md
) into https://owncloud.dev/ocis/identity-provider/OIDC - the detail description with the exampled (currently contained in
flow.md
) into https://owncloud.dev/apis/http/authorization - link both places together
@saw-jan here is a reference to a docs issue (For AD FS openid connect the ADFS admin may need to enable cors headers) which could be interresting because of: "To do that, the ADFS 2019 level functionality may need to be enabled: |
5ca69ee
to
1c47ad0
Compare
dab3724
to
4ef98c1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some tiny change requests
''etcd'', ''consul'', ''memory'' and ''mdns''. Will be selected automatically. Only change | ||
on supervision of ownCloud Support.' | ||
''etcd'', ''consul'', ''memory'' and ''mdns''. Will be selected automatically. | ||
Only change under supervision of ownCloud Support.' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should not be part of this PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
at first, my IDE auto-fix new-line, later reviewed on #7452 (comment) so I thought this small change could go in this PR. If there is any problem I can revert anytime.
4ef98c1
to
6d93b6e
Compare
6d93b6e
to
32b973a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor text changes suggested. I will commit these, then I think that we can merge this.
@individual-it @amrita-shrestha I think that this can be merged. Do we need review/input from anyone else? |
@individual-it just some smaller improvements before merging. |
Co-authored-by: Martin <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Kudos, SonarCloud Quality Gate passed! |
Co-authored-by: Phil Davis <[email protected]> Co-authored-by: Artur Neumann <[email protected]> Co-authored-by: Martin <[email protected]>
Description
This PR introduces documentation related to OIDC, detailing how oCIS can serve as an IDP. The document provides steps to obtain an access token using both curl and a browser.
Related Issue
Motivation and Context
Previously, there was documentation pertaining to using other services as IDPs in oCIS, along with some OIDC login flow information. However, documentation regarding oCIS serving as an IDP was lacking. This PR addresses this gap by adding comprehensive documentation on oCIS as an IDP.
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: