This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Localization Support in Identity Server

This page describes how WSO2 Identity Server can be configured to support localization of its UI.

Configuring localization for authentication endpoints

WSO2 IS provides internationalization support for the web apps (such as the authentication endpoint stored in the <IS_HOME>/repository/deployment/server/webapps/ directory). The following steps describe how you can configure this:

  1. Navigate to the <IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/org/wso2/carbon/identity/application/authentication/endpoint/i18n/ directory.
  2. Make a copy of the Resources.properties file, rename it with the required locale suffix as follows: 

    • For British English: Resources_en_GB.properties

    • For French (Standard): Resources_fr.properties

    Refer Web browser language identification codes for more information on required locale suffixes.

  3. Update the values for the keys listed in the file. Example: login=<Value in the required locale>
  4. Save the file.
  5. Open the browser's settings and add the language you configured above.
  6. Restart the server.
  7. Do the following to test the above configuration.
    1. Open a browser.
    2. Type the dashboard URL. (If you are running the server in your localhost, the URL is: https://localhost:9443/dashboard/). The login screen will display contents in the language your configured.

Follow the steps given below to localize error messages coming from authentication-framework/oauth-framework.

  1. First, you need to generate a key from the message itself for the properties file:
    1. Get the "oauthErrorMsg" message from the URL and decode the URL (URLDecode)
    2. Encode the "oauthErrorMsg" message to Base64.
    3. Replace "= with _" in the encoded message.
  2. Now look for a value in Resource.properties file with the relevant locale. If a match is found, define a value for the property. Otherwise, use 'add new property' entry to the relevant locale based on the Resource file as explained above. If you don't specify a value for the key obtained above, the error message itself will be displayed in the UI.