ORCID authentication lets you allow existing ORCID users to sign in to a Turnkey system by configuring ORCID credentials in the system's extra settings file.

What ORCID authentication does

ORCID is an OpenID authentication provider used in the scientific community. An ORCID account can contain information such as a user's university affiliations and research grants.

In MDriven, you use ORCID authentication when you want users to authenticate to your Turnkey application with their existing ORCID credentials.

Configure ORCID authentication

Configure ORCID authentication in the TurnkeySettingsExtra file. These settings are not maintained in the Portal.

1. Obtain an ORCID client ID and client secret for your application.
2. Create or update the TurnkeySettingsExtra file for the Turnkey system.
3. Add the ORCID settings inside the <root> element.
4. Set the redirect URL to the public URL of your system followed by /Account/orcid.
5. Place the settings file in the application's AppData directory. You can use the AssetsTK strategy to deliver the file to that directory.

Settings example

Replace the example values with the values for your ORCID application and Turnkey system.

<root>
  <OrcidAuthentication_ClientId>your ORCID client ID</OrcidAuthentication_ClientId>
  <OrcidAuthentication_ClientSecret>your ORCID client secret</OrcidAuthentication_ClientSecret>
  <OrcidAuthenticationRedirectUrl>https://yoursystem/Account/orcid</OrcidAuthenticationRedirectUrl>
  <OrcidSandbox>true</OrcidSandbox>
</root>

Setting reference

Setting	Purpose	Example
OrcidAuthentication_ClientId	Identifies your application to ORCID.	your ORCID client ID
OrcidAuthentication_ClientSecret	Supplies the secret associated with the ORCID client ID.	your ORCID client secret
OrcidAuthenticationRedirectUrl	Specifies the URL to which ORCID redirects the user after authentication. The path must be /Account/orcid.	https://yoursystem/Account/orcid
OrcidSandbox	Selects whether the ORCID sandbox is used. Set this value to true or false.	true

Redirect URL requirement

The redirect URL must use your system's own URL and end with /Account/orcid. For example, if users access the system at https://research.example.org, configure:

<OrcidAuthenticationRedirectUrl>https://research.example.org/Account/orcid</OrcidAuthenticationRedirectUrl>

Do not leave the redirect URL as yoursystem/Account/orcid; replace yoursystem with the actual address of the deployed Turnkey system.

Store the settings file

The ORCID settings must be available in the AppData directory of the deployed system. The AssetsTK strategy is a practical way to put the TurnkeySettingsExtra file there.

Treat OrcidAuthentication_ClientSecret as a secret. Do not use an example or placeholder value in a deployed system.

See also

• Documentation:BankId