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

Ensure OrcID requirements are met for the integration #225

Closed
holtgrewe opened this issue Nov 22, 2023 · 3 comments · Fixed by #226
Closed

Ensure OrcID requirements are met for the integration #225

holtgrewe opened this issue Nov 22, 2023 · 3 comments · Fixed by #226
Labels
enhancement New feature or request

Comments

@holtgrewe
Copy link
Member

Is your feature request related to a problem? Please describe.
We need to fulfill the following requirements for the OrcID integration:

Describe the solution you'd like
Create a checklist from the following two documents and ensure that we meet all of them:

Describe alternatives you've considered
N/A

Additional context
N/A

@holtgrewe holtgrewe added the enhancement New feature or request label Nov 22, 2023
@holtgrewe
Copy link
Member Author

holtgrewe commented Nov 22, 2023

Minimal Requirements Checklist

  • Use OAuth to authenticate ORCID iDs (Do not allow users search for or type in ORCID iDs.)
  • Include an ORCID branded button or link on your site to initiate authentication of the iD.
  • Present the OAuth authorization screen according to our guidelines
  • Use HTTPS for your site’s redirect URIs and on ORCID API calls
  • Accept and store all data returned in the token exchange together with the user’s data in your system
  • Use appropriate scopes and request methods (e.g. POST calls to add new information and PUT calls to update existing information)
  • Publicly display the authenticated ORCID iDs. iDs should be displayed following our trademark and iD display guidelines.

@holtgrewe
Copy link
Member Author

Integration Guidelines

[...]

We have successfully integrated with the OrcID sandbox so this will work.

@holtgrewe
Copy link
Member Author

holtgrewe commented Nov 22, 2023

Screenshots demonstrating OrcID sandbox integration

  • Reev frontpage with login button on top right:
  • Login button on top right brings you to the login page
    • https://reev.cubi.bihealth.org/login
    • image
    • The button follow the [OrcID user experience guidelines](Buttons or links connecting ORCID via OAuth)
      • Buttons and links connecting to ORCID should use the ORCID iD icon.
      • Make sure that the button/link text clearly describes what will happen when it is clicked or selected.
  • Clicking the "Login with ... OrcID" button brings us to the sandbox login page
    • image
  • A correct login brings us back to the profile page
    • image
  • The profile page displays the user's OrcID
    • image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant