Configurations

Overview
Common Configs
Console Specific Configs

Overview

The portals i.e. Console & My Account are configurable using the deployment.toml when they are hosted inside the Identity Server. The Jinja 2 template files which can be found in features/org.wso2.identity.apps.{$appName}.server.feature/resources/deployment.config.json.j2 are used to template the configuration file i.e. deploymemnt.config.json which can be found at the root of the webapp.

Note: If the portals are to be hosted outside, the aforementioned deployment.config.json file has to be modified accordingly.

To learn more abut the new configuration model, click here.

Common Configs

The following sections contain the common configs that are needed to configure/override the existing behaviour of the Console or My Account application.

`app_base_name`

✅ Default JSON value - "console" | "myaccount"

This configuration is needed if you want to change app base name from console or myaccount to something else.

Note: Changing just the bellow config will not be enough to achieve the desired results. You will have to manually rename the application in <IS_HOME>/repository/deployment/server/webapps. And also you will have to refactor the paths(links to the theme, rpIframe etc.) in index.jsp at the root of the console webapp.

Supported Values - Any string value

[console]
app_base_name = "custom-console"

Note for Developers: If you want to build the application with a different basename, change this config in <REPO_ROOT>/apps/console/src/public/deployment.config.json. Webapack will use this value during build time to put all the build files.

`app_base_name_for_history_api`

💡 No value defined in Default JSON

🏁 Fallback Value - "/"

Base name used by the browser history API. For the default SaaS behaviour / has been used due to limitations in history API. See remix-run/history#644. This config was added to enable support for none SaaS apps so that they can easily history push.

Supported Values - Any path with a leading forward slash.

[console]
app_base_name_for_history_api = "/console"

`client_id`

✅ Default JSON value - "CONSOLE" | "MY_ACCOUNT"

Client ID of the application.

Supported Values - Any string value. Check the OIDC configurations section of the application to retrieve the correct value.

[console]
client_id = "CONSOLE"

`debug`

✅ Default JSON value - false

Enable debug logs for certain features such as i18n etc.

Supported Values - true | false

[console]
debug.enable = true

`idp_configs`

Configs for the authentication SDK.

`enablePKCE`

💡 No value defined in Default JSON

🏁 Fallback Value - true

The Proof Key for Code Exchange (PKCE) is a specification supported by WSO2 Identity Server to mitigate code interception attacks. See Mitigating Authorization Code Interception Attacks to configure PKCE for an OAuth application.

Supported Values - true | false

[console]
idp_configs.enablePKCE = true

`clockTolerance`

💡 No value defined in Default JSON

🏁 Fallback Value - 60 Seconds (Declared in SDK)

Allowed leeway when validating the id_token. Required to address possible time mismatches between the client and the server. Check the Specification

Supported Values - Any number (in Seconds)

[console]
idp_configs.clockTolerance = 120

`responseMode`

💡 No value defined in Default JSON

🏁 Fallback Value - "form_post"

How the result of the authorization request is formatted.

Supported Values - "form_post" | "query"

[console]
idp_configs.responseMode = "form_post"

`scope`

💡 No value defined in Default JSON

🏁 Fallback Value - [ "SYSTEM" ]

Scopes requested when the token request is made.

Supported Values - String array

[console]
idp_configs.scope = [ "internal_login", "internal_identity_mgt_view" ]

`serverOrigin`

💡 No value defined in Default JSON

🏁 Fallback Value - "https://localhost:9443"

The origin of the Identity Provider. eg: https://localhost:9443

Supported Values - Any URL.

[console]
idp_configs.serverOrigin = "https://localhost:9443"

`storage`

💡 No value defined in Default JSON

🏁 Fallback Value - "webWorker"

The storage medium where the session information such as the access token should be stored.

Supported Values - "sessionStorage" | "webWorker" | "localStorage"

[console]
idp_configs.storage = "webWorker"