Set up Single Sign-On for Trellix APD

Prev Next

The primary integration scope is enabling Single Sign-On from the Trellix NDR console to the portal. The integration uses IDP-initiated SAML for authentication.

Generate authentication keys using the CLI

Create the necessary metadata XML file from the Trellix NDR console.

  1. Log in to the Trellix NDR console CLI using a terminal window.

    $ ssh npadmin@<Your NDR Console IP address>

  2. Enable privileged mode.

    npadmin@hostname> enable

  3. Enter configuration mode.

    npadmin@hostname# configure system

    The prompt changes to indicate active configuration mode.

  4. Open the Configure Deepsurface menu to generate the metadata XML.

    npadmin@hostname(config)# attack-path-discovery

  5. On the Configure Deepsurface page, do the following:

    APD_Configure_Deepsurface.png
    • Type 1 to generate the metadata XML file.

    • Type 2 to download the generated metadata XML file.

      The file is saved to /home/npscp/transfer.

    • Type X to exit the configuration menu.

  6. Open a secure file transfer client on your local computer.

  7. Connect to the Trellix NDR console using npscp account credentials.

  8. Navigate to the /home/npscp/transfer directory.

  9. Download the generated metadata XML file to your local machine.

Share the metadata XML file with Trellix Support

  1. Email the generated metadata XML file and your customer ID to Trellix Support.

  2. Trellix Support uses the file to provision your dedicated cloud tenant.

  3. Trellix Support confirms the tenant creation and completes the authentication setup.

Once configured, the Trellix APD service processes signed SAML responses against the designated Assertion Consumer Service (ACS) URL.

Note

The ACS URL format is https://{customer-id}.{region}.trellix-apd.com/v1/sso/saml2/acs. The region is currently fixed to "us".