Configure Single Sign-On Enterprise¶
TestGen supports Single Sign-On (SSO) through any authentication provider that implements the OpenID Connect (OIDC) protocol, such as Okta, Microsoft Entra ID, or Auth0, or Ping Identity.
When SSO is enabled, users authenticate through your identity provider instead of using TestGen's built-in login. System administrators can still assign roles to users and manage project membership from the Administration console.
Prerequisites¶
- TestGen instance installed using dk-installer, as outlined in Install Enterprise.
- An OIDC-compatible identity provider with a registered application. You will need: client ID, client secret, and the provider's server metadata URL.
Configure your identity provider¶
- Create a new application registration in your identity provider for TestGen.
- Set the redirect URI to your TestGen base URL (for example,
https://testgen.example.com). - Note the client ID, client secret, and server metadata URL for use in the next step.
- Optional. To grant system administrator access via SSO, create an
adminrole in your identity provider and assign it to the appropriate users. Configure the provider to include assigned roles in therolesclaim of the ID token.
Configure TestGen¶
- Navigate to the directory that contains the
docker-compose.ymlfile for TestGen. -
Create a file named
sso_auth.tomlin the same directory with the following content. Replace the placeholders with values from your identity provider. -
Add the following SSO environment variables under the x-common-variables section in
docker-compose.yml. -
Add a volume mount to the engine service in
docker-compose.ymlto make the TOML file available to TestGen. -
Restart the application.
How roles work with SSO¶
When a user logs in through SSO, TestGen checks the roles claim in the ID token for the value admin (case-insensitive). If found, the user is granted system administrator access. The user's project-level roles are managed separately through project membership.
To set the claim name to something other than roles, update the TG_SSO_ROLES_CLAIM variable in docker-compose.yml.
System administrators can assign project roles (such as Data Quality or Analyst) to users from the Administration console after the user's first login.