ユーザーにユーザーの作成または接続を要求する場合 ORCID iD システムに、システムにすでに保存されている情報を入力し、表示言語を設定し、アクティブなセッションからサインアウトして正しいサインインを確認することで、研究者の時間と労力を節約できます。 ORCID アカウント。
この ORCID APIは、ユーザーエクスペリエンスをカスタマイズするためのいくつかのオプションを提供します
登録/サインインフォームに事前に記入してください
ORCID メンバーがhttps：//のパラメーターを使用して、APIインタラクションの一部としてOAuth登録/サインインフォームに事前に入力するオプションを提供します。orcid.org/oauth/authorize URL
パラメータのいずれかまたはすべてを使用できます。
| フィールド | ノート | |
| 名前 | 名 | この ファーストネーム フィールドはに入力されます 登録用紙 指定されたメールアドレスまたは ORCID iD アクティブなものと一致しません ORCID 記録。 |
| 家族の名前 | 苗字 | この 苗字 フィールドはに入力されます 登録用紙 指定されたメールアドレスまたは ORCID iD アクティブなものと一致しません ORCID 記録。 |
| メール | この Eメール/ORCID iD フィールドはに入力されます サインインフォーム 指定されたメールアドレスがシステムに見つかり、有効でない場合 ORCID iD が指定されています。 email フィールドはに入力されます 登録用紙 指定されたメールアドレスがシステムに見つかり、有効でない場合 ORCID iD メールアドレスは次のようになります。 URLエンコード、「@」を「％40」に変更することを含みます。ユーザーの ORCID iD とメールアドレス、私たちはお勧めします の 提供する ORCID iD セクションに orcid パラメータに一致する最初のデバイスのリモートコントロール URL を返します。 | |
| orcid | ORCID iD | この Eメール/ORCID iD フィールドはに入力されます サインインフォーム 指定されている場合 ORCID iD 私たちのシステムにあります。 登録用紙 それ以外の場合は、指定された場合に表示されます ORCID iD 私たちのシステムには見つかりません。 ORCID iD にある必要があります の16桁の形式 iD URI. |
これらのパラメータを持つURLの例は次のとおりです。
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com
0
0
表示言語を設定する
ORCID https：//の「lang」パラメータを使用してAPIインタラクションの一部としてOAuth登録/サインインフォームの表示言語を指定するオプションを提供しますorcid.org / oauth / authorizeURL。 これにより、ユーザーの言語表示設定も設定されます。
ユーザー いつでも自分で表示言語を変更できます。 次の言語設定が利用可能です。
| 言語 | Code |
| عربى (アラビア語) | ar |
| čeština（チェコ） | cs |
| 英語 | en |
| 日本語Español（スペイン語） | es |
| フランス語（フランス語） | fr |
| ドイツ語（ドイツ語） | de |
| イタリア語（イタリア語） | it |
| 日本語（日本語） | ja |
| 한국어（韓国語） | ko |
| ポルスキ（ポーランド語） | pl |
| ポルトガル語（ポルトガル語） | pt |
| Русский（ロシア語） | ru |
| Türkçe（トルコ語） | tr |
| 简体中文（簡体字中国語） | zh_CNに |
| 繁體中文（繁体字中国語） | zh_TW |
0
0
例
この例では、フォームに事前に入力し、言語をスペイン語に設定します
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huck%40mailinator.com
&lang=es デフォルトはサインインフォームまたは登録フォームです
現在 ORCID OAuth画面には、デフォルトでサインインフォームが表示され、登録フォームに切り替えるためのリンクが表示されます。 デフォルトの動作に関係なく、表示されるフォームは、パラメーター「＆show_login = true」を追加してサインインフォームを表示するか、「＆show_login = false」を追加して登録フォームを表示することで設定できます。 メールアドレスまたは ORCID iD URLで指定されている場合、表示される形式はこれらのパラメーターによって決定され、＆show_loginパラメーターは無視されます。
ORCID 包含に関する私たちの価値観に沿って、アクセシビリティを向上させるために、エンドユーザーがOAuthサインインウィンドウのサイズを変更できるようにするベストプラクティスを強くお勧めします。
カスタムの「状態」パラメータによって研究者を識別します
これは、技術的な理由から一部の統合で使用されます。サインイン画面には表示されません。
システム内のユーザーの内部識別子に変換される一意の番号のシーケンスなど、ユーザーを識別するために、状態パラメーターを承認URLに含めることができます。 このパラメーターはユーザーエクスペリエンスに影響を与えませんが、認証コードとともに返され、ユーザーまたはセッションを識別するために使用できます。 ユーザーがアクセスを拒否した場合も、stateパラメーターが返されます。
state パラメータには 2000 文字の制限があることに注意してください。
オプションで、強制的にサインアウトします
XNUMX台のマシンに複数のユーザーがいることが心配な場合は、ユーザーをログアウトできます。
複数のユーザーが同じマシン上にいて、セッション間でサインアウトしないことが懸念される場合は、OAuthプロセス中にユーザーに再認証を強制することができます。 単に含める prompt=login OAuthリクエストで。 また、max_ageを秒単位で設定して、セッションが特定の長さを超えている場合にユーザーに再認証を強制することもできます。 私たちを参照してください OpenIDConnectのドキュメント のガイドをご参照ください。
0
1
承認をスキップする
ORCID 特定の状況で認証をスキップします。
OAuth認証URLが要求するのと同じスコープでアクティブなアクセストークンがすでに存在し、ユーザーがサインインしている場合 ORCID 記録すると、認証を再度付与するように求められることはありません。 代わりに、リダイレクトURIに直接移動します。 ユーザーが接続するたびに認証を付与するようにユーザーに要求する場合は、 強制サインアウト方法
1
0