How-to
Configuring ORCID Sign-In
Turning on sign-in with ORCID through an ORCID client, knowing who can sign in this way and allowing a person to sign in with ORCID.
Sign-in with ORCID is only for people who are already known to the system, and no new account is opened with ORCID. While the setting is on, the Sign in with ORCID button appears on the sign-in screen.
Turning the setting on
- On orcid.org, create a free Public API client in the developer tools.
- On the Administration → Site settings screen, open the ORCID tab.
- Copy the address in the Redirect URI field and add it to the redirect URIs of the ORCID client.
- In the Environment list, select Production (orcid.org). For trials, use Sandbox (sandbox.orcid.org).
- In the Client ID field, enter the 20-character ID that starts with
APP-. - In the Client secret field, enter the client secret.
- Press Save.
- Press Test connection and check that ORCID recognises the client.
- Turn on the Allow signing in with ORCID switch.
- Press Save again.
The test uses the saved settings, and the button is off while there are unsaved changes. If ORCID does not recognise the client or orcid.org cannot be reached, the reason appears next to the button.
The client secret is stored encrypted and is never shown again. If you leave the field empty and save, the stored secret is kept. The server must be able to reach orcid.org. The line at the top of the card shows whether sign-in with ORCID is on and how many accounts can sign in with ORCID.
When you turn the switch off and save, the button disappears and sign-in with ORCID stops at once.
Who can sign in
- People whose ORCID iD an administrator entered on their user page or in their invitation.
- People who linked their ORCID account themselves with the Link my ORCID account button on the My profile → Security tab.
An ORCID iD that the person typed into their own profile does not allow them to sign in. A person who comes with an unknown ORCID iD is told that no account is set up with this iD. Disabled and locked accounts cannot sign in with ORCID either. Accounts with two-factor authentication turned on are still asked for the code.
The first ORCID sign-in and every account link are reported to the person by e-mail. Every sign-in is written to the audit log with its method.
Allowing a person to sign in with ORCID
- On the Administration → Users & roles screen, press the user's name.
- In the ORCID iD for signing in field on the Profile details card, enter the person's ORCID iD.
- Press Save next to the field.
To withdraw the permission, empty the field and save. An ORCID iD can be used for signing in on only one account. The ORCID sign-in: assigned label shows that an administrator gave the permission. The ORCID sign-in: verified label shows that the person has signed in with ORCID at least once or linked their account themselves.
How the person signs in with ORCID is described in Signing in with ORCID.