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

Please add the callback URL to OpenID connect docs #2914

Open
antifuchs opened this issue Jan 13, 2025 · 1 comment
Open

Please add the callback URL to OpenID connect docs #2914

antifuchs opened this issue Jan 13, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@antifuchs
Copy link

antifuchs commented Jan 13, 2025

I just set up an OIDC IDP with pocket-id that docspell can use to authenticate, and one thing that had me scratching my head at first was that there's no mention of the "final" URL on the docspell side that the authentication process will redirect to.

While it can be discovered with browser devtools or by reading the source code, I think it's better to just mention it: It's https://<docspell-base-hostname>/api/v1/open/auth/openid/<provider-id>/resume (:

Would you mind adding that to the documentation?

@eikek
Copy link
Owner

eikek commented Jan 13, 2025

That is definitely a good idea! :)

If very lucky or patient :) there is some hint at the api docs:
https://docspell.org/openapi/docspell-openapi.html#tag/Authentication/operation/open-auth-openid-resume

Perhaps that can be linked in the doc page about openid authentication.

@eikek eikek added the documentation Improvements or additions to documentation label Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants