Contribute to the DSpace Development Fund

The newly established DSpace Development Fund supports the development of new features prioritized by DSpace Governance. For a list of planned features see the fund wiki page.

DRAFT

The ORCID Login functionality described on this page is available out of the box since DSpace 9.0. For organizations using earlier versions of DSpace, code is available for implementing full ORCID Login features for DSpace 7.x (https://github.com/DSpace/DSpace/pull/9846) and DSpace 8.x (https://github.com/DSpace/DSpace/pull/9847).


The ORCID login allows the user to access the repository using their ORCID login credentials through the ORCID system.

By clicking on Log in via ORCID, the user will be redirected externally to log in to ORCID website.

When logging in for the first time, different scenarios can occur.


Never registered users

Unknown or same email as ORCID

When clicking on Log in with ORCID, the ORCID log in page will show, and the user can sign in with their ORCID credentials or register for an ORCID iD if they don't already have one.

To make the integration work at its best, general ORCID record visibility needs to be set for Everyone. (Learn more about ORCID visibility settings.)


At the end of the procedure, access to DSpace for data should be granted. After saving, the user will be redirected to DSpace.

The page will list the data retrieved from ORCID and let the user provide a new email address to register to DSpace or connect the ORCID account to an existing user.

The email is usually hidden on this page if it is not set to public/everyone visibility on ORCID. It will be retrieved and shown as user data if it's public.

For new registration, an email should be provided to create a profile after sending the verification link and verifying the email address.

If the user's email address from ORCID is not retrieved or if the user confirms the same email as ORCID, the system will successfully create a new user in DSpace.

Confirming a different email from ORCID

If the user's email address is set as public in ORCID, when logging in to DSpace, the system will also receive and show the email as user data.

In this case, the user can provide DSpace with the same email address and complete the registration.

If the email address provided to DSpace differs from the one received from ORCID, the user, after the email verification, will review the account information and choose the data to keep in the system in case there are duplicate values.

With the toggle of the override column, the user can decide whether to keep the existing value by setting it to OFF or overwrite the information by setting the toggle to ON.

After clicking on Save and confirming, the account is successfully created, and the user will be redirected to the Profile page, where, if needed, they can update some of the information.


User registered in DSpace with a different email from ORCID

If the user has registered to DSpace and ORCID with different emails, the steps to be followed are similar to the previous.

After logging in with ORCID for the first time with an email never registered to DSpace, the system will retrieve information from ORCID and ask if to create a new account by providing a new email or connect to an existing user.

By clicking on Connect to an existing user, the login pop-up will show, in which input the DSpace credentials.

After logging in, the user can review the information that will be associated with the existing account.

By clicking on Save, and confirming the willingness to go on, the user will be redirected to the Profile page in which, if needed, update some of the information.

ORCID can be connected to an existing ePerson also from the personal page.


User logging in with same email for ORCID and DSpace

If the user has already registered on DSpace and log in with ORCID with the same email address, the ORCID and DSpace profile will be connected, associating the profile and the ORCID number.


ORCID Login flow

This is the overview of the flow for the ORCID Login.




  • No labels