Custom Header authentication

Last modified by Aurelie Bertrand on 2026/01/12 16:46

This document describes how to set up the authentication method passing a custom header in requests to DigDash Enterprise.
The value of the custom header will be the remote user.

This document describes the file to modify to enable this authentication.

Configuration of DigDash applications

All DigDash Enterprise applications are configured via a single file: digdash.properties.

The use of this file is described here: Externalization of parameters in a properties file

In everything that follows, the default application names will be used. If you have renamed certain war files you will need to modify the digdash.properties file accordingly.

Server (ddenterpriseapi.war)

Find the definition of the authMethod parameter (uncomment the line by deleting the # character at the beginning of the line) and change its value to Custom :

ddenterpriseapi.authMethod=Custom

the definition of the Custom_idParameter parameter and change its value according to the name of your header:

ddenterpriseapi.Custom_idParameter=sm_universalid

the definition of the digdash_dashboard.sharedPasswd parameter.
Change the password value (all applications using this same parameter must use the same value).

ddenterpriseapi.sharedPasswd=SecretPwdToChange

The password specified must be identical to the one you set in the other applications.

Dashboard (digdash_dashboard.war)

the definition of the authMethod parameter and change its value to Custom :

digdash_dashboard.authMethod=Custom

the definition of the Custom_idParameter parameter and change its value according to the name of your header:

digdash_dashboard.Custom_idParameter=sm_universalid

the definition of the digdash_dashboard.sharedPasswd parameter.
Change the password value (all applications using this same parameter must use the same value).

digdash_dashboard.sharedPasswd=SecretPwdToChange

The password specified must be identical to the one you set in the other applications.

Recommended settings for automatic dashboard login:

It is recommended that you configure the following settings when deploying in Integrated Windows Security (Waffle) mode.

Specify (and force) the DigDash Enterprise domain:

digdash_dashboard.DOMAIN=ddenterpriseapi
digdash_dashboard.FORCEDOMAIN=true

Specify (and force) the server URL of the DigDash Enterprise domain.
Use the localhost address if the ddenterpriseapi web application is installed on the same Tomcat as the digdash_dashboard web application.
Adapt the port if necessary:

digdash_dashboard.SERVERURL=http://localhost:8080
digdash_dashboard.FORCESERVERURL=true

Specify a logout URL so that the user can log out of DigDash Enterprise and, for example, return to an Intranet page:

digdash_dashboard.urlLogout=/adminconsole

By default, logging out of the dashboard returns to the dashboard login page. This page does not exist in the SSO context.
It is important to specify a return URL in the event of disconnection.

See the documentation Advanced system settings documentation for more details on these settings.

Studio (studio.war)

Find the definition of the authMethod parameter and change its value to Custom :

studio.authMethod=Custom

the definition of the Custom_idParameter parameter and change its value according to the name of your header:

studio.Custom_idParameter=sm_universalid

the definition of the digdash_dashboard.sharedPasswd parameter.
Change the password value (all applications using this same parameter must use the same value).

studio.sharedPasswd=SecretPwdToChange

The password specified must be identical to the one you set in the other applications.

Recommended settings for automatic Studio login:

It is recommended that you configure the following settings when deploying in Integrated Windows Security (Waffle) mode.

Specify (and force) the DigDash Enterprise domain:

studio.FORCEDOMAIN=true
studio.DOMAIN=ddenterpriseapi

Specify (and force) the server URL of the DigDash Enterprise domain.
Use the localhost address if the ddenterpriseapi web application is installed on the same Tomcat as the studio application.
Adapt the port if necessary:

studio.FORCESERVERURL=true
studio.SERVERURL=http://localhost:8080

Specify a logout URL so that the user can log out of DigDash Enterprise and, for example, return to an Intranet page:

studio.urlLogout=/adminconsole

By default logging out of the Studio returns to the Studio login page. This page does not exist in the SSO context.
It is important to specify a return URL in the event of disconnection.sktop Studio (adminconsole.war