Setting up tenants


As a SaaS administrator, to enable the single sign-on experience for a customer company, you must first create a tenant on the BMC Helix Single Sign-On server, and then proceed with the onboarding tasks for this tenant.

Default tenant

The SAAS TENANT is the default tenant, which is available on the BMC Helix SSO server. Only a SaaS administrator has access to this tenant. 

The SAAS TENANT has a predefined name which you cannot modify. You cannot disable this tenant. You can only modify the default description and Host.

SaaS tenant.png

To create a tenant

  1. Log in to the BMC Helix SSO server as a SaaS administrator. 
  2. On the navigation panel, click Tenant
  3. Click Add Tenant.
  4. To add a tenant, complete the following fields:
    • Name 
    • Hostname—Specify the hostname to access an individual tenant by using the following format: host.example.com
    • (Optional) Description
    • (Optional) Self-service configuration 

      Important

      The tenant name and tenant host name must be unique.  

  5. To enable the tenant, select the Enabled check box.
  6. Click Save.

To modify the SAAS tenant host name

  1. Log in to BMC Helix SSO server as a SaaS Administrator.
  2. On the navigation panel, click Tenant
  3. Click Edit Tenant image-2023-9-27_15-38-14.pngfor the SaaS Tenant you want to update. 
  4. Update the Tenant hostname and click Save

    This option not available if the host name value was set by using the RSSO_SAAS_HOST environment variable.

To enable features for a tenant

Use feature flags to enable specific functionalities for a tenant.

  1. Edit or create a tenant for which you want to update the feature flags.
  2. Select the check boxes with the functionalities to be enabled for a tenant.

    Functionality

    Description

    Reference

    Local User Management "Confirm Registration"

    Helps local users to set their own password.

    Local User Management "Forgot Password"

    Helps local users to reset a forgotten, lost, or compromised password.

    Disable email template sanitizing

    Helps to check and modify the email template input in the Forgot Password functionality.

    Webhooks on authentication response

    Helps to notify an external service about user authentication in BMC Helix SSO by using webhooks.

    Path-specific session cookie

    Helps to limit the scope of the cookie to the /rsso path on the BMC Helix SSO server.

    Use tenant token timeouts for multi-tenant clients

    Helps to apply the same access and refresh timeout values that are defined for the particular tenant level for multi-tenant clients.

    Hide copyright

    Helps administrators to hide the BMC copyright message on the login page of the integrated BMC application.

    Enable attribute extraction from SAML IdP

    Enables creation of user attributes and claims to use from data extracted from SAML IdP requests.  

    UI idle timeout

    Enables user logout from a BMC application integrated with BMC Helix SSO due to inactivity in the UI based on defined criteria.

    This option is available for deployments where applications are protected by the BMC Helix SSO agent:

    • Deployments where the BMC Helix SSO agent communicates with the BMC Helix SSO server using the legacy flow.
    • Deployments where the BMC Helix SSO agent is deployed with multi-domain support.
    • Deployments where the BMC Helix SSO agent is protected by Auth Proxy.

    Check TCP connection

    Enables the Check TCP connection feature in the Service tab of a tenant. Helps administrators to troubleshoot failed connections between BMC Helix SSO and other applications. The Host, Port, and Type fields are required. In the Type field (available with version 23.1.01 and later), select a Transmission Control Protocol (TCP) connection type established between the BMC Helix SSO server and an integrated BMC application:

    • Plain — Non-TLS connection.
    • Encrypted insecure — TLS connection without certificate verification.
    • Encrypted secure — TLS connection with certificate verification.

    After you add values to these fields, click Send. A command line shows whether a connection is successful.

    MSP server side

    Enables the BMC Helix SSO Server with a realm identifying functionality on the server side. It is used for multi-domain applications to enhance configuration experience for user sessions. MSP server side feature is applicable for a BMC Helix SSO Agent and Auth Proxy. 

    All these features are disabled by default.

  3. Click Save.
    The changes are applied automatically for a tenant.

To switch to the Admin Console view of a tenant 

  1. On the List of Tenants page, select a tenant.
  2. Click the pin button.

    An information message is displayed above the navigation panel stating which tenant you have selected:

    Switch to another tenant.png

    The Tenant field on the navigation panel displays the name of the tenant you have switched to.  

Where to go from here

After you have created a tenant, create administrators for this tenant. For information about how to create a tenant administrator, see Setting-up-BMC-Helix-SSO-administrator-accounts.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*