Skip to content

Commit a087d28

Browse files
Rob BlackburnRob Blackburn
Rob Blackburn
authored and
Rob Blackburn
committed
typos
1 parent 3b58c33 commit a087d28

File tree

14 files changed

+57
-158
lines changed

14 files changed

+57
-158
lines changed

‎docs/Other_methods_for_getting_authorised_iDs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Configuration steps and customization options vary widely between systems - chec
1111

1212
##Institutional sign-in
1313

14-
You can enable access using institutional credentials. Check out the (Members Documentation)[http://members.orcid.org/api/integrate/institution-sign-in] for more information.
14+
You can enable access using institutional credentials. Check out the [Members Documentation](http://members.orcid.org/api/integrate/institution-sign-in) for more information.
1515

1616

1717
##Share my iD

‎site/404.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@
274274

275275

276276
<li class="md-nav__item">
277-
<a href="/Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
278-
10. Vendor and Institutional Sign In
277+
<a href="/Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
278+
10. Other methods for getting authorised iDs
279279
</a>
280280
</li>
281281

site/Vendor_Institution/index.html renamed to site/Other_methods_for_getting_authorised_iDs/index.html

Lines changed: 7 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737

3838

39-
<title>10. Vendor and Institutional Sign In - Hands-on with the ORCID API</title>
39+
<title>10. Other methods for getting authorised iDs - Hands-on with the ORCID API</title>
4040

4141

4242

@@ -99,7 +99,7 @@
9999
Hands-on with the ORCID API
100100
</span>
101101
<span class="md-header-nav__topic">
102-
10. Vendor and Institutional Sign In
102+
10. Other methods for getting authorised iDs
103103
</span>
104104

105105

@@ -285,11 +285,11 @@
285285

286286

287287
<label class="md-nav__link md-nav__link--active" for="__toc">
288-
10. Vendor and Institutional Sign In
288+
10. Other methods for getting authorised iDs
289289
</label>
290290

291-
<a href="./" title="10. Vendor and Institutional Sign In" class="md-nav__link md-nav__link--active">
292-
10. Vendor and Institutional Sign In
291+
<a href="./" title="10. Other methods for getting authorised iDs" class="md-nav__link md-nav__link--active">
292+
10. Other methods for getting authorised iDs
293293
</a>
294294

295295

@@ -319,33 +319,6 @@
319319
Institutional sign-in
320320
</a>
321321

322-
<nav class="md-nav">
323-
<ul class="md-nav__list">
324-
325-
<li class="md-nav__item">
326-
<a href="#configure-api-credentials" title="Configure API credentials" class="md-nav__link">
327-
Configure API credentials
328-
</a>
329-
330-
</li>
331-
332-
<li class="md-nav__item">
333-
<a href="#user-connect-your-institutional-account" title="(User) Connect your institutional account" class="md-nav__link">
334-
(User) Connect your institutional account
335-
</a>
336-
337-
</li>
338-
339-
<li class="md-nav__item">
340-
<a href="#exchange-authorization-code-for-access-token-authenticated-id" title="Exchange authorization code for access token &amp; authenticated iD" class="md-nav__link">
341-
Exchange authorization code for access token &amp; authenticated iD
342-
</a>
343-
344-
</li>
345-
346-
</ul>
347-
</nav>
348-
349322
</li>
350323

351324
<li class="md-nav__item">
@@ -423,33 +396,6 @@
423396
Institutional sign-in
424397
</a>
425398

426-
<nav class="md-nav">
427-
<ul class="md-nav__list">
428-
429-
<li class="md-nav__item">
430-
<a href="#configure-api-credentials" title="Configure API credentials" class="md-nav__link">
431-
Configure API credentials
432-
</a>
433-
434-
</li>
435-
436-
<li class="md-nav__item">
437-
<a href="#user-connect-your-institutional-account" title="(User) Connect your institutional account" class="md-nav__link">
438-
(User) Connect your institutional account
439-
</a>
440-
441-
</li>
442-
443-
<li class="md-nav__item">
444-
<a href="#exchange-authorization-code-for-access-token-authenticated-id" title="Exchange authorization code for access token &amp; authenticated iD" class="md-nav__link">
445-
Exchange authorization code for access token &amp; authenticated iD
446-
</a>
447-
448-
</li>
449-
450-
</ul>
451-
</nav>
452-
453399
</li>
454400

455401
<li class="md-nav__item">
@@ -496,47 +442,15 @@
496442

497443

498444

499-
<h1>10. Vendor and Institutional Sign In</h1>
445+
<h1>10. Other methods for getting authorised iDs</h1>
500446

501447
<h2 id="other-methods-for-getting-authorised-ids">Other methods for getting authorised iDs</h2>
502448
<p>You have just followed a method a custom integration would use to get ORCIDs from users. The following</p>
503449
<h2 id="vendor-systems">Vendor systems</h2>
504450
<p>Some publishing, research information and repository software systems support collecting authenticated iDs and permissions right out of the box. See our list of <a href="https://members.orcid.org/api/orcid-enabled-systems">ORCID-enabled systems</a> for more details.</p>
505451
<p>Configuration steps and customization options vary widely between systems - check your system's documentation for complete information.</p>
506452
<h2 id="institutional-sign-in">Institutional sign-in</h2>
507-
<p>ORCID recently added the option to sign in using institutional credentials. Institutional sign-in is available to researchers affiliated with members of supported identity federations, currently <a href="https://www.surf.nl/en/services-and-products/surfconext/index.html">SURFconext</a> and <a href="https://technical.edugain.org/status.php">eduGAIN</a>.</p>
508-
<p>ORCID membership is not required in order for institutional sign-in to work for your researchers, however, ORCID members who are <a href="https://www.surf.nl/en/services-and-products/surfconext/index.html">SURFconext</a> or <a href="https://technical.edugain.org/status.php">eduGAIN</a> federation members can automatically request ORCID iDs and ORCID record access permission from users who sign into ORCID with their institutional credentials using the new Institutional Collect &amp; Connect feature.</p>
509-
<p>In this section, we'll take a look at this feature. <a href="https://members.orcid.org/api/integrate/institution-sign-in">Learn more about ORCID institutional signin, including configuring up your IdP</a></p>
510-
<h3 id="configure-api-credentials">Configure API credentials</h3>
511-
<p>In addition to getting Member API credentials as described above, ORCID will need a few more pieces of information to set up Institutional Collect &amp; Connect for your organization.</p>
512-
<p>To have your API credentials configured for Institutional Collect &amp; Connect, contact <a href="../support@orcid.org">support@orcid.org</a> with the following information:</p>
513-
<ul>
514-
<li>Client ID</li>
515-
<li>Identity provider entity ID (e.g. https://idp.example.org/idp/shibboleth)</li>
516-
<li>Redirect URI: The page on your site that users should be directed to after they complete the cross-link process. This can bedifferent from the redirect URI you use for other ORCID API applications.</li>
517-
<li>Permission scope(s) that you would like (<code>/authenticate</code>, <code>/read-limited</code>, <code>/activities/update</code>, <code>/person/update</code>)</li>
518-
</ul>
519-
<h3 id="user-connect-your-institutional-account">(User) Connect your institutional account</h3>
520-
<p><strong>Not a member of a supported federation?</strong> Test out ORCID institutional sign-in with a <a href="https://app.unitedid.org/signup">United ID</a> account. United ID is a free and independent online identity service <em>(Note: United ID requires use of a 2-Factor Authentication method, like <a href="https://support.google.com/accounts/answer/1066447?hl=en">Google Authenticator</a>)</em>.</p>
521-
<ol>
522-
<li>Sign out of your Sandbox record - click the <strong>Sign out</strong> button in the upper right corner or visit <a href="https://sandbox.orcid.org/signout">https://sandbox.orcid.org/signout</a></li>
523-
<li>Visit <a href="https://sandbox.orcid.org/signin">https://sandbox.orcid.org/signin</a> and click <strong>Sign in using your Institutional Account</strong></li>
524-
<li>Enter your organization's name in the box, or choose to pick it from the list.
525-
<img src="../images/04-3_signin-inst-account.png" width="400" alt="ORCID sign-in screen showing institutional account sign-in"></li>
526-
<li>Sign into your institution account<br>
527-
<img src="../images/04-3_united-id-login.png" width="400" alt="United ID login screen"></li>
528-
<li>Finish linking your accounts by signing into ORCID with your ORCID username and password. Enter the email address / ORCID iD and password for your Sandbox account and click <strong>Sign into ORCID</strong>. <em>You will only need to complete this step once - in the future you can log directly into ORCID with your institutional account.</em><br>
529-
<img src="../images/04-3_link-account.png" width="600" alt="ORCID link accounts screen"></li>
530-
<li>After linking your accounts, a message appears at the top of your ORCID record, prompting you to connect your iD to your institution. Click the <strong>Connect</strong> button.<br>
531-
<img src="../images/04-3_inst-connect-banner.png" width="600" alt="ORCID record showing institution connect message" /></li>
532-
<li>An ORCID sign-in screen listing the requested permissions will appear; click <strong>Authorize</strong><br>
533-
<img src="../images/04-3_inst-connect-oauth.png" width="400" alt="ORCID OAuth sign-in screen" /></li>
534-
<li>After granting permission, you'll be redirected to the Redirect URI specified for your API credentials - this page should show a success or error message depending on whether <strong>Authorize</strong> or <strong>Deny</strong> was clicked, and it should also provide a link back to ORCID and links to your local ORCID resources.<br>
535-
<img src="../images/04-3_inst-connect-redirect.png" width="600" alt="Example success message shown to users after completing the institution connect process" /></li>
536-
</ol>
537-
<h3 id="exchange-authorization-code-for-access-token-authenticated-id">Exchange authorization code for access token &amp; authenticated iD</h3>
538-
<p>Like in section 4.1.4 above, an authorization code is attached to the end of the redirect URI, which can be exchanged for an access token and the user's ORCID iD.<br>
539-
<img src="../images/04-3_inst-connect-auth-code.png" width="600" alt="Browser address bar showing OAuth authorization code" /></p>
453+
<p>You can enable access using institutional credentials. Check out the (Members Documentation)[http://members.orcid.org/api/integrate/institution-sign-in] for more information.</p>
540454
<h2 id="share-my-id">Share my iD</h2>
541455
<p>Need a quick way to collect authenticated iDs with no programming or IT resources needed?
542456
<a href="https://share-my-id.orcid.org/">Share my iD</a> is a new app from ORCID that allows anyone with an ORCID iD to get iDs from other ORCID users.<br>

‎site/display/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@
357357

358358

359359
<li class="md-nav__item">
360-
<a href="../Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
361-
10. Vendor and Institutional Sign In
360+
<a href="../Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
361+
10. Other methods for getting authorised iDs
362362
</a>
363363
</li>
364364

‎site/get/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -359,8 +359,8 @@
359359

360360

361361
<li class="md-nav__item">
362-
<a href="../Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
363-
10. Vendor and Institutional Sign In
362+
<a href="../Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
363+
10. Other methods for getting authorised iDs
364364
</a>
365365
</li>
366366

@@ -539,7 +539,7 @@ <h3 id="get-an-authorization-code">Get an authorization Code</h3>
539539
<img src="../images/04-2_auth-code.png" width="400" alt="Browser address bar showing OAuth authorization code" /></li>
540540
</ol>
541541
<h3 id="exchange-authorization-code-for-access-token-authenticated-id">Exchange authorization code for access token &amp; authenticated iD</h3>
542-
<p>Once you have an Authorization Code, you can exchange it for an Access Token and the Authenticated iD of the user who signed in, which you'll need in order to take the API action(s) you requested permission for.</p>
542+
<p>Once you have an Authorization Code, you can exchange it for an Access Token and the Authenticated iD of the user who signed in, which you'll need in order to take the API action(s) you requested permission for. You need to store this securely and privately as it contains access tokens, normally you would store this in a database, for now you can store it in a text file on your computer.</p>
543543
<p>In a real-world situation, this exchange would be done by your system, using a programming language such as PHP, Java, or Ruby on Rails. For this tutorial, we'll use Google OAuth Playground to simulate a web application.</p>
544544
<ol>
545545
<li>Click the gear icon in the upper right corner to open the <strong>OAuth 2.0 Configuration</strong><br>

‎site/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -333,8 +333,8 @@
333333

334334

335335
<li class="md-nav__item">
336-
<a href="Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
337-
10. Vendor and Institutional Sign In
336+
<a href="Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
337+
10. Other methods for getting authorised iDs
338338
</a>
339339
</li>
340340

@@ -435,7 +435,7 @@ <h2 id="pre-requisites">Pre-requisites</h2>
435435
<p>Examples in this doc use <a href="https://developers.google.com/oauthplayground/">Google OAuth Playground</a></p>
436436
<p>You can also use
437437
- <a href="http://curl.haxx.se/download.html">cURL</a>: Free, command-line application available for Mac or Windows (pre-installed on most Mac OS versions; accessible within Terminal application)
438-
- Or other online tools, like <a href="http://hurl.it&quot;&gt;hurl.it">hurl.it</a></p>
438+
- Or other online tools, like <a href="https://insomnia.rest/">Insomnia</a></p>
439439
<p>Once you have got to grips with the APIs you can use our <a href="https://pub.sandbox.orcid.org/v2.0/">Swagger</a> graphical interface.</p>
440440
<h2 id="about-the-orcid-apis">About the ORCID APIs</h2>
441441
<p>ORCID's web interface gives researchers a way to interact with their record, but the real power of ORCID lies in the underlying data, which can be accessed by people and systems via Application Programming Interfaces (APIs).</p>

‎site/post/index.html‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,8 @@
319319

320320

321321
<li class="md-nav__item">
322-
<a href="../Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
323-
10. Vendor and Institutional Sign In
322+
<a href="../Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
323+
10. Other methods for getting authorised iDs
324324
</a>
325325
</li>
326326

@@ -376,7 +376,8 @@
376376

377377
<h1>5. POST&#58; an affiliation</h1>
378378

379-
<p>Now that we've got an Access Token, we can use it like a password to take the API actions we requested permission for (in this case, to update activities). In this section, we'll add an education affiliation to our Sandbox record.</p>
379+
<p>Now that we've got an Access Token, we can use it like a password to take the API actions we requested permission for.</p>
380+
<p>In this section, we'll add an education affiliation to our Sandbox record. You can use the API to, POST (add), PUT (update), DELETE, or read any section of the record, the only things you need to change are the endpoints and the XML for each section. In the following example we are using the /education endpoint with the <a href="https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/education-2.1.xml">correct XML</a> to add the information, but you can just as well add Employment or Works for example. See our <a href="https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/README.md">Github documentation</a> for more example files and endpoints and the permissions you need for each.</p>
380381
<h2 id="add-an-education-affiliation">Add an education affiliation</h2>
381382
<p>Still have that Google OAuth Playground window open? If so, continue with step 1 below. If not, go back and repeat the <a href="../collect/#get-an-authorization-code">Get an authorization code</a> and <a href="../collect/#exchange-authorization-code-for-access-token-authenticated-id">Exchange authorization code for an access token</a> steps from the previous section before moving on to the steps below.</p>
382383
<ol>
@@ -400,7 +401,7 @@ <h2 id="add-an-education-affiliation">Add an education affiliation</h2>
400401
<li>Copy the education affiliation XML at the end of this section and paste it into the <strong>Request Body</strong> text box<br>
401402
<img src="../images/06-1_request-body.png" width="600" alt="Google OAuth Playground Request Body configuration for new education affiliation" /></li>
402403
<li><strong>OPTIONAL:</strong> In the <strong>Request Body</strong> text box, edit the XML to reflect your institution.<br>
403-
<em>For <code>&lt;disambiguated-organization-identifier&gt;</code>, use the <a href="http://ido.ringgold.com/identify_new/cfm/si_pd.cfm?PID=1">Ringgold Identify database</a> to find the Ringgold ID for your institution (you'll need to <a href="http://ido.ringgold.com/identify_new/cfm/si_pd.cfm?PID=24">register a free Ringgold account</a> in order to search the database).</em></li>
404+
<em>For <code>&lt;disambiguated-organization-identifier&gt;</code>, use the <a href="https://www.ringgold.com/identify/">Ringgold Identify database</a> to find the Ringgold ID for your institution (you'll need to <a href="https://ido.ringgold.com/register">register a free Ringgold account</a> in order to search the database).</em></li>
404405
<li>Click <strong>Close</strong>.</li>
405406
<li>Click <strong>Send the request</strong>.</li>
406407
<li>The results will appear in the <strong>Request/Response</strong> section at right. Scroll to the bottom – if you see <strong>HTTP/1.1 201 Created</strong>, your education affiliation was successfully added!<br>
@@ -414,7 +415,7 @@ <h2 id="education-affiliation-xml">Education affiliation XML</h2>
414415
&lt;education:education
415416
xmlns:common=&quot;http://www.orcid.org/ns/common&quot; xmlns:education=&quot;http://www.orcid.org/ns/education&quot;
416417
xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;
417-
xsi:schemaLocation=&quot;http://www.orcid.org/ns/education ../education-2.0.xsd &quot;&gt;
418+
xsi:schemaLocation=&quot;http://www.orcid.org/ns/education ../education-2.0.xsd &quot;&gt;
418419
&lt;education:department-name&gt;Department&lt;/education:department-name&gt;
419420
&lt;education:role-title&gt;Degree title&lt;/education:role-title&gt;
420421
&lt;common:start-date&gt;
@@ -423,14 +424,14 @@ <h2 id="education-affiliation-xml">Education affiliation XML</h2>
423424
&lt;common:day&gt;01&lt;/common:day&gt;
424425
&lt;/common:start-date&gt;
425426
&lt;education:organization&gt;
426-
&lt;common:name&gt;My University&lt;/common:name&gt;
427+
&lt;common:name&gt;ORCID&lt;/common:name&gt;
427428
&lt;common:address&gt;
428-
&lt;common:city&gt;Some City&lt;/common:city&gt;
429+
&lt;common:city&gt;Bethesda&lt;/common:city&gt;
429430
&lt;common:region&gt;Region&lt;/common:region&gt;
430431
&lt;common:country&gt;US&lt;/common:country&gt;
431432
&lt;/common:address&gt;
432433
&lt;common:disambiguated-organization&gt;
433-
&lt;common:disambiguated-organization-identifier&gt;XXXXXX&lt;/common:disambiguated-organization-identifier&gt;
434+
&lt;common:disambiguated-organization-identifier&gt;385488&lt;/common:disambiguated-organization-identifier&gt;
434435
&lt;common:disambiguation-source&gt;RINGGOLD&lt;/common:disambiguation-source&gt;
435436
&lt;/common:disambiguated-organization&gt;
436437
&lt;/education:organization&gt;

‎site/put/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,8 @@
319319

320320

321321
<li class="md-nav__item">
322-
<a href="../Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
323-
10. Vendor and Institutional Sign In
322+
<a href="../Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
323+
10. Other methods for getting authorised iDs
324324
</a>
325325
</li>
326326

‎site/read/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,8 @@
319319

320320

321321
<li class="md-nav__item">
322-
<a href="../Vendor_Institution/" title="10. Vendor and Institutional Sign In" class="md-nav__link">
323-
10. Vendor and Institutional Sign In
322+
<a href="../Other_methods_for_getting_authorised_iDs/" title="10. Other methods for getting authorised iDs" class="md-nav__link">
323+
10. Other methods for getting authorised iDs
324324
</a>
325325
</li>
326326

0 commit comments

Comments
 (0)