Supported Identity Providers

Configuration

In your .env file, make sure you have the following value set.

TRACECAT__AUTH_TYPES=saml
TRACECAT__SETTING_OVERRIDE_SAML_ENABLED=true

Instructions

Okta

1

Create an SAML app

Go to Applications and select Add Application. Select SAML 2.0 and click on Create.

2

Configure SAML settings

  • Set the Single sign-on URL, Recipient URL, and Destination URL to https://<your-tracecat-instance>/auth/saml/acs.
  • Set the Audience Restriction to https://<your-tracecat-instance>.

3

Configure attribute statements

Map email to user.email

4

Configure SAML settings in environment variables

Set the following environment variables in your .env file:

  • SAML_IDP_METADATA_URL: Okta metadata URL
5

Restart Tracecat instance

Restart Tracecat to apply the changes.

6

Test SSO configuration

Navigate to your Tracecat instance and click on the Login button. You should be redirected to Okta for authentication.

Microsoft Entra ID

1

Create an SAML app

Go to Enterprise applications and select the New application button. Find and select the Microsoft Entra SAML toolkit app.

2

Configure SAML settings

  • Set the Reply URL and Sign on URL to https://<your-tracecat-instance>/auth/saml/acs.
  • Set Identifier to https://<your-tracecat-instance>/api.
  • Set Relay State to https://<your-tracecat-instance>.

3

Configure attribute and claims

Map email to user.mail

Authentik

1

Create a provider

Go to Providers and select the Create button. Choose SAML Provider and select the Next button.

2

Configure the provider

  • Enter a name and choose an authorization flow
  • Set the ACS URL to https://<your-tracecat-instance>/auth/saml/acs.
  • Set the Audience to https://<your-tracecat-instance>/api.

3

Configure assertion signing

  • Expand the Advanced protocol settings section.
  • Select a Signing Certificate and ensure Sign assertions is enabled.

4

Configure property mapping

  • Select authentik default SAML Mapping: Name in Selected User Property Mappings.
  • Click the < button to deselect it.
  • Select the Finish button.

5

Create an Application

Go to Applications and select the Create button. Fill in the details as desired.

6

Find metadata URL

  • Select the provider you created previously.
  • Select the Metadata tab.
  • Select the Copy download URL button.
7

Configure SAML settings in environment variables

Set the following environment variables in your .env file:

  • SAML_IDP_METADATA_URL: Metadata download URL
8

Restart Tracecat instance

Restart Tracecat to apply the changes.

9

Test SSO configuration

Navigate to your Tracecat instance and click on the Login button. You should be redirected to Authentik for authentication.