ユーザーにユーザーの作成または接続を要求する場合 ORCID iD システムに、システムにすでに保存されている情報を入力し、表示言語を設定し、アクティブなセッションからサインアウトして正しいサインインを確認することで、研究者の時間と労力を節約できます。 ORCID アカウント。
ORCID 包含に関する私たちの価値観に沿って、アクセシビリティを向上させるために、エンドユーザーがOAuthサインインウィンドウのサイズを変更できるようにするベストプラクティスを強くお勧めします。
その ORCID APIは、ユーザーエクスペリエンスをカスタマイズするためのいくつかのオプションを提供します
表示言語を設定する
ORCID https://orcid.org/oauth/authorize URL の「lang」パラメータを使用して、API 対話の一部として OAuth 登録/サインイン フォームの表示言語を指定するオプションを提供します。これにより、ユーザーの言語表示設定も設定されます。
ユーザー いつでも自分で表示言語を変更できます。 次の言語設定が利用可能です。
| 言語 | CPコード |
|---|---|
| عربى (アラビア語) | ar |
| čeština(チェコ) | cs |
| 英語 | en |
| 日本語Español(スペイン語) | es |
| フランス語(フランス語) | fr |
| ドイツ語(ドイツ語) | de |
| イタリア語(イタリア語) | it |
| 日本語(日本語) | ja |
| 한국어(韓国語) | ko |
| ポルスキ(ポーランド語) | pl |
| ポルトガル語(ポルトガル語) | pt |
| Русский(ロシア語) | ru |
| Türkçe(トルコ語) | tr |
| 简体中文(簡体字中国語) | zh_CNに |
| 繁體中文(繁体字中国語) | zh_TW |
例:
この例では、フォームに事前に入力し、言語をスペイン語に設定します
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」を追加すると登録フォームが表示されます。
カスタムの「状態」パラメータによって研究者を識別します
認証URLに状態パラメータを含めることで、ユーザーを識別できます。状態パラメータには、システム内でユーザーの内部識別子として解釈される一意の数字列などが含まれます。このパラメータはユーザーエクスペリエンスには影響しませんが、認証コードと共に返され、ユーザーまたはセッションを識別するために使用できます。状態パラメータには2000文字の制限があることにご注意ください。
オプションで、強制的にサインアウトします
XNUMX台のマシンに複数のユーザーがいることが心配な場合は、ユーザーをログアウトできます。
複数のユーザーが同じマシン上にいて、セッション間でサインアウトしないことが懸念される場合は、OAuthプロセス中にユーザーに再認証を強制することができます。 単に含める prompt=login OAuth リクエストで。
承認をスキップする
ORCID 特定の状況で認証をスキップします。
OAuth認証URLが要求するのと同じスコープでアクティブなアクセストークンがすでに存在し、ユーザーがサインインしている場合 ORCID 記録すると、認証を再度付与するように求められることはありません。 代わりに、リダイレクトURIに直接移動します。 ユーザーが接続するたびに認証を付与するようにユーザーに要求する場合は、 強制サインアウト方法