ORCID Integration Configuration

DSpace-CRIS provides a full integration with ORCID based on the ORCID API v3.0. The full range of ORCID API is supported ranging from the Public API to the Membership and Premium API

Configuration

Integration with ORCID requires the following configuration properties:

• orcid.domain-url → ORCID domain url

• orcid.authorize-url → ORCID endpoint to get an OAuth Authorization Code for the specified scopes

• orcid.token-url → ORCID endpoint to exchange the authorization code for an access token

• orcid.api-url → The root of the ORCID registry API url

• orcid.redirect-url → the complete url of the DSpace side rest endpoint on which the browser must redirect the user after logging in on the orcid registry (during the “3 legged OAuth”)

• orcid.webhook-url → The root of the ORCID registry webhook endpoints

• orcid.public-url → the url of the public endpoints of ORCID registry

• orcid.application-client-id → the id credential provided by ORCID after the application registration

• orcid.application-client-secret → the secret provided by ORCID after the application registration

• orcid.scope → the list of the access scopes that the application requires; these scopes are used in the OAuth authenticate process where the user grants the specific permission asked for.

The reference configuration file of the features linked to orcid is the orcid.cfg file placed in config/modules, while the configuration of the main beans used for the functionalities related to orcid is defined in the file config/spring/api/orcid-services.xml.

In this file, in addition to the properties listed above, there are also the default configurations for all the functions related to orcid (webhook, mapping between DSpace entities and ORCID entities, etc.).

For more details about the application registration on ORCID click here.

Functional Specifications