|
| 1 | +# Configure cookie consent banner |
| 2 | + |
| 3 | +{{ product_name }} displays a cookie consent banner on the Console and MyAccount portals by default. This banner informs users about cookie usage and allows them to accept or manage their cookie preferences. |
| 4 | + |
| 5 | +You can control the visibility of the cookie consent banner at different levels: |
| 6 | + |
| 7 | +- **Globally**: Enable or disable the banner across all applications |
| 8 | +- **Per application**: Control the banner visibility for specific applications (Console or MyAccount) |
| 9 | + |
| 10 | +## Enable/Disable cookie consent banner globally |
| 11 | + |
| 12 | +To enable/disable the cookie consent banner globally across all applications, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file. |
| 13 | + |
| 14 | +```toml |
| 15 | +[ui.cookie_consent_banner] |
| 16 | +enabled=false |
| 17 | +``` |
| 18 | + |
| 19 | +!!! note |
| 20 | + By default, the cookie consent banner is enabled. Set `enabled=false` to disable it globally. |
| 21 | + |
| 22 | +## Enable/Disable cookie consent banner per application |
| 23 | + |
| 24 | +You can control the cookie consent banner visibility for specific applications without affecting the global configuration. This allows you to disable the banner for the Console or MyAccount portal independently. |
| 25 | + |
| 26 | +### For Console |
| 27 | + |
| 28 | +To control the visibility of the cookie consent banner only for the Console application, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file: |
| 29 | + |
| 30 | +```toml |
| 31 | +[console.ui] |
| 32 | +is_cookie_consent_banner_enabled=false |
| 33 | +``` |
| 34 | + |
| 35 | +### For My Account |
| 36 | + |
| 37 | +To control the visibility of the cookie consent banner only for the MyAccount portal, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file: |
| 38 | + |
| 39 | +```toml |
| 40 | +[myaccount.ui] |
| 41 | +is_cookie_consent_banner_enabled=false |
| 42 | +``` |
| 43 | + |
| 44 | +!!! note "Important" |
| 45 | + - These configurations do not affect the authentication or recovery portals. They only determine whether the banner is shown within the respective applications. |
| 46 | + - Per-application settings override the global configuration for that specific application. |
| 47 | + - By default, the cookie consent banner is enabled for both Console and MyAccount applications. |
| 48 | + |
| 49 | +## Priority order for configurations |
| 50 | + |
| 51 | +When determining whether to display the cookie consent banner, {{ product_name }} follows this priority order: |
| 52 | + |
| 53 | +1. **Per-application configuration**: If a global and a per-application setting are present, the per-application configuration takes precedence for that application. |
| 54 | + |
| 55 | +2. **Global configuration**: If no per-application configuration exists, the global setting applies. |
| 56 | + |
| 57 | +3. **Default behavior**: If no configuration is specified, the cookie consent banner is enabled by default. |
0 commit comments