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.

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

Merged
merged 7 commits into from
Oct 31, 2023
Merged

[docs-only]Document ocis as a IDP #7452

merged 7 commits into from
Oct 31, 2023

Conversation

amrita-shrestha
Copy link
Contributor

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

  • Fixes <issue_link>

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?

  • test environment:
  • test case 1:
  • test case 2:
  • ...

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation ticket raised:

@update-docs
Copy link

update-docs bot commented Oct 10, 2023

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 amrita-shrestha changed the title Document ocis as a IDP [docs-only]Document ocis as a IDP Oct 10, 2023
@amrita-shrestha amrita-shrestha marked this pull request as ready for review October 11, 2023 06:36
docs/apis/http/oidc/_index.md Outdated Show resolved Hide resolved
docs/apis/http/oidc/authorization-code-flow.md Outdated Show resolved Hide resolved
docs/apis/http/oidc/_index.md Outdated Show resolved Hide resolved
docs/apis/http/oidc/authorization-code-flow.md Outdated Show resolved Hide resolved
docs/apis/http/oidc/authorization-code-flow.md Outdated Show resolved Hide resolved
docs/helpers/extended_vars.yaml Outdated Show resolved Hide resolved
@mmattel
Copy link
Contributor

mmattel commented Oct 11, 2023

@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.

Comment on lines 1 to 9
---
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
---
Copy link
Member

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

Copy link
Contributor

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/

Copy link
Member

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.

Copy link
Member

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

@mmattel
Copy link
Contributor

mmattel commented Oct 11, 2023

@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:
Invoke-AdfsFarmBehaviorLevelRaise"

Copy link
Member

@individual-it individual-it left a 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

docs/ocis/identity-provider/oidc/flow.md Outdated Show resolved Hide resolved
docs/ocis/identity-provider/oidc/flow.md Outdated Show resolved Hide resolved
Comment on lines -42 to +43
''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.'
Copy link
Member

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

Copy link
Contributor Author

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.

docs/ocis/identity-provider/oidc/_index.md Outdated Show resolved Hide resolved
docs/ocis/identity-provider/oidc/flow.md Outdated Show resolved Hide resolved
Copy link
Contributor

@phil-davis phil-davis left a 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.

docs/apis/http/authorization.md Outdated Show resolved Hide resolved
docs/apis/http/authorization.md Outdated Show resolved Hide resolved
docs/apis/http/authorization.md Outdated Show resolved Hide resolved
@phil-davis
Copy link
Contributor

@individual-it @amrita-shrestha I think that this can be merged. Do we need review/input from anyone else?

@mmattel
Copy link
Contributor

mmattel commented Oct 30, 2023

@individual-it just some smaller improvements before merging.

Co-authored-by: Martin <github@diemattels.at>
Copy link
Contributor

@mmattel mmattel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@sonarcloud
Copy link

sonarcloud bot commented Oct 31, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@individual-it individual-it merged commit 7dc7558 into master Oct 31, 2023
2 checks passed
@delete-merged-branch delete-merged-branch bot deleted the ocis-as-idp-docs branch October 31, 2023 08:07
ownclouders pushed a commit that referenced this pull request Oct 31, 2023
Co-authored-by: Phil Davis <phil@jankaritech.com>
Co-authored-by: Artur Neumann <artur@jankaritech.com>
Co-authored-by: Martin <github@diemattels.at>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants