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

[Feature] Document authentication methods and related authenticated-user details #344

Closed
fmigneault opened this issue Aug 3, 2020 · 0 comments · Fixed by #399
Closed
Assignees
Labels
doc Documentation improvements or building problem enhancement Improvements in term of performance or behaviour help wanted

Comments

@fmigneault
Copy link
Collaborator

Although Magpie offers multiple external provider login methods, these are poorly documented, making it hard for devs and users to even know about them (relates to #173).

Also, even for "internal provider", it is not clearly documented how to authenticate one-self. Some details can be inferred from OpenAPI definitions, but one has to dig quite a lot to find such details. These details should be provided more explicitly in docs, such as :

Given that authentication is such a main component of interactions with Magpie, appropriate details should be provided, in a dedicated section in the docs.

These details should also consider changes in #340 which provide new functionalities based on non-admin level users.
Doc should be provided to better explain contextual request behavior (ie: when Logged User is applicable to views).

@fmigneault fmigneault added enhancement Improvements in term of performance or behaviour help wanted doc Documentation improvements or building problem labels Aug 3, 2020
@fmigneault fmigneault self-assigned this Aug 3, 2020
@fmigneault fmigneault pinned this issue Oct 26, 2020
fmigneault added a commit that referenced this issue Mar 24, 2021
fmigneault added a commit that referenced this issue Mar 26, 2021
fmigneault added a commit that referenced this issue Mar 29, 2021
@fmigneault fmigneault unpinned this issue Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation improvements or building problem enhancement Improvements in term of performance or behaviour help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants