カスタムスコープの言語別説明文の登録

概要

カスタムスコープの説明文を言語別に設定したい場合、Authlete の API を呼び出すことにより可能となります。

実行例

標準スコープ群については、日本語の説明文が、descriptions の中に次のようなかたちで含まれています。

{
  "name": "openid",
  "defaultEntry": false,
  "description": "A permission to request an OpenID Provider to issue an ID Token. See OpenID Connect Core 1.0, 3.1.2.1. for details.",
  "descriptions": [
    {
      "tag": "en",
      "value": "A permission to request an OpenID Provider to issue an ID Token. See OpenID Connect Core 1.0, 3.1.2.1. for details."
    },
    {
      "tag": "ja",
      "value": "OpenID プロバイダーに ID トークンの発行を要求するための権限です。詳細は OpenID Connect Core 1.0, 3.1.2.1. を参照してください。"
    }
  ]
}

カスタムスコープについては、/service/update API を直接利用し、descriptions を更新することで、言語別説明文を Authlete に登録することができます。

注意事項

API を用いて設定したカスタムスコープの descriptions は、GUI を用いてサービス情報を更新すると消去されます。