Registering localized descriptions for custom scopes

Overview


You can specify localized descriptions for your custom scopes by making a request to Authlete's API.

Examples


Standard scopes have been configured to include Japanese text in descriptions as follows:

    {
                                "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. を参照してください。" 
                                  }
                                ]
                              },

On custom scopes, you can register your own text for each language to Authlete by updating descriptions with /service/update API.

Notes


The descriptions registered via the API will be removed if you update service settings via GUI.
How did we do with this article?