Allow an ORCID to be associated with a Dataverse account

[philippconzett]

There are several open issues about ORCID support in Dataverse, e.g. #4236 . As a first step, I'd like to suggest to add a new field in the account creation form, thus the form used when creating a Dataverse account by filling in a user name, name, email address etc. In the suggested new field, users can add their ORCID (in Dataverse installations where ORCID log-in is enabled, users could of course also use that option; see #4236 , but this issue is simply about adding an ORCID field in the account creation form). The ORCID information added in this way should be available when a user creates a new dataset: The ORCID field in the author section of the Citation Metadata field should be pre-filled with the ORCID of the user depositing the dataset.

[DS-INRAE]

We (Recherche Data Gouv team) will make a PR to address this issue, we should be starting to work on this in December.

[pdurbin]

As agreed during a meeting this morning, @DS-INRA will reach out to @philippconzett and @qqmyers about this. Thanks for offering to make a PR! ❤️

[DS-INRAE]

Edit : this has been postponed to 2024 on our roadmap, but we still plan on contributing on this bit.

[DS-INRAE]

Here is a (WIP) list of actions to create smaller issues (and pull requests) :

• Add ORCiD to an authenticated user data
  • Refactor user creation via ORCiD (+migration scripts)
  • Refactor JSF retrieval of ORCiD to populate a new dataset
  • Add ORCiD field in JSF creation form (this issue)
  • Edit ORCiD field in JSF account informations
  • Add ORCiD to the API user creation request
    • Add ORCiD field in SPA creation form
    • Edit a user's ORCiD via API
      • Edit ORCiD field in SPA account informations

There are certainly other prerequisites on the SPA side and maybe the issues for user creation and edit already exist and would not be new ones.

[DS-INRAE]

Great news for ORCID integration: Dataverse received a grant from the ORCID foundation!

[DS-INRAE]

We'll therefore release this issue but will be happy to contribute 😃

[pdurbin]

@philippconzett the title of this issue is "Add ORCID as a new field in the account creation form" but I'm wondering if we can re-title this issue and have it be automatically closed by this new pull request by @qqmyers:

• ORCID: Support authenticated ORCIDs in account profile #11222

In that pull request, you can't simply type in ORCID. You go through the normal dance to log in with ORCID and only then is your ORCID saved to your Dataverse account.

So, a suggested new title for this issue could be something like "Allow an ORCID to be associated with a Dataverse account". The pull request above delivers this.

[jggautier]

In addition to changing the title of this GitHub issue, should we create new issues related to "Add ORCiD to the API user creation request"? I think means that if someone uses the API to create an account, they can include an ORCID.

Or will the PR at #11222 make it possible to create accounts using the API and add an ORCID to that account?

[pdurbin]

Well, I can imagine a parallel issue for https://github.com/IQSS/dataverse-frontend ... something like "allow an ORCID to be associated with a Dataverse account". We will need to implement something similar in React to have feature parity. But what I'm trying to say is that I think @qqmyers has taken the right approach of having the Dataverse user actually authenticate against ORCID to prove that they control the ORCID ID. So no, that PR doesn't allow a user to fill in a random ORCID (they might not even own) via API. It's a different, more trustworthy, implementation.

[jggautier]

Thanks, yeah I get that.

I'm just mentioning that something that @DS-INRAE wrote in this GitHub issue earlier, about being able to use the API to create an account and add an ORCID to that account, wouldn't be addressed by a pull request that you're suggesting should close this issue when that PR is merged.

I didn't think that @DS-INRAE was suggesting that we should let users use the API to create an account with a random or unauthenticated ORCID.

@DS-INRAE is that what you had in mind?

[pdurbin]

So, a suggested new title for this issue could be something like "Allow an ORCID to be associated with a Dataverse account". The pull request above delivers this.

@philippconzett head ups that I re-titled this issue.

Also, as discussed at standup, I marked this issue to be closed when this PR is merged:

• ORCID: Support authenticated ORCIDs in account profile #11222

@philippconzett @DS-INRAE or anyone reading this, please create additional issues as needed. Thanks!

[philippconzett]

@pdurbin Thanks for the heads-up! Sounds good. As of v6.5(?) depositors can look up authors's name and ORCID in the the Author field. This might be sufficient for now. If we experience that there will be a need to be able to add ORCID information to the user account information, we can create a new issue.

[pdurbin]

able to add ORCID information to the user account information

That's what #11222 gives us. Sorry, if I'm misunderstanding what you mean. Maybe can talk it out in Zulip! 😄

[philippconzett]

Ah, sorry for the confusion. I now see from the PR that it will enable users to connect to ORCID and pull the ORCID into the Dataverse account information independently of whether you use ORCID to log in to Dataverse. So, the PR covers my original request in this issue. Thanks!