Service Provider (SP) initiated login

This article will walk you through how to enable SAML single sign-on for your Braze account and how to obtain a SAML trace.

Requirements

Upon setup, you will be asked to provide a sign-on URL and an Assertion Consumer Service (ACS) URL.

Setting up SAML SSO

Step 1: Configure your identity provider

Set up Braze as a service provider (SP) in your identity provider (IdP) with the following information. In addition, set up SAML attribute mapping.

Step 2: Configure Braze

When you finish setting up Braze in your identity provider, your identity provider will provide you with a target URL and x.509 certificate to input into your Braze account.

After your account manager turns on SAML SSO for your account, go to Settings > Admin Settings > Security Settings and toggle the SAML SSO section to ON.

On the same page, input the following:

Make sure that your x.509 certificate follows this format when adding it to the dashboard:

1
2
3
-----BEGIN CERTIFICATE-----
<certificate>
-----END CERTIFICATE-----

Step 3: Sign into Braze

Save your security settings and log out. Then, sign back in with your identity provider.

Setting up your RelayState

1. In Braze, go to Settings > APIs and Identifiers.
2. In the API Keys tab, select the Create API key button.
3. In the API key name field, enter a name for your key.
4. Extend the SSO dropdown under Permissions and check sso.saml.login.
   
   
   
   
5. Select Create API key.
6. In the API Keys tab, copy the identifier next to the API key you created.
7. Paste the RelayState API Key into your IdP’s RelayState (it may also appear as “Relay State” or “Default Relay State” depending on your IdP).

SSO behavior

Members who opt to use SSO will no longer be able to use their password as they did prior. Users who continue to use their password will be able to unless restricted by the following settings.

Restriction

You can restrict the members of your organization to only sign in with either Google SSO or SAML SSO. To turn on restrictions, go to Security Settings and select either Enforce Google SSO only login or Enforce custom SAML SSO only login.

By turning on restrictions, your company’s Braze users will no longer be able to log in using a password, even if they have logged in with a password before.

Obtaining a SAML trace

If you experience login issues related to SSO, obtaining a SAML trace can help you troubleshoot your SSO connection by identifying what’s sent in the SAML requests.

Prerequisites

To run a SAML trace, you’ll need a SAML tracer. Here are two possible options based on your browser:

• Google Chrome
• Mozilla Firefox

Step 1: Open the SAML tracer

Select the SAML tracer from your browser’s navigation bar. Be sure Pause isn’t selected as this will prevent the SAML tracer from capturing what’s sent in the SAML requests. When the SAML tracer is open, you’ll see it populate the trace.

Step 2: Sign into Braze using SSO

Go to your Braze dashboard and attempt to sign in using SSO. If you encounter an error, open the SAML tracer and try again. A SAML trace has been successfully collected if there’s a row with a URL like https://dashboard-XX.braze.com/auth/saml/callback and an orange SAML tag.

Step 3: Export and send to Braze

Select Export. For Select cookie-filter profile, select None. Then, select Export. This will generate a JSON file that you can send to Braze Support for further troubleshooting.

Troubleshooting

Is the user’s email address correctly set up?

If you’re getting the error ERROR_CODE_SSO_INVALID_EMAIL, the user’s email address isn’t valid. Confirm in the SAML trace that the saml2:Attribute Name="email" field matches the email address the user is using to log in. If you use Microsoft Entra ID, the attribute mapping is email = user.userprincipalname.

The email address is case sensitive and must exactly match the one that was set up in Braze, including the one configured in your identity provider (such as Okta, OneLogin, Azure Active Directory, and others).

Other errors that indicate you have issues with the user’s email address include:

• ERROR_CODE_SSO_EMAIL_DOES_NOT_EXIST: The user’s email address isn’t within the dashboard.
• ERROR_CODE_SSO_SESSION_SIGN_IN_EMAIL_MISSING: The user’s email address is blank or otherwise misconfigured.
• ERROR_CODE_SSO_SESSION_SIGN_IN_EMAIL_MISMATCH or ERROR_CODE_SSO_SIGN_IN_EMAIL_MISMATCH: The user’s email address doesn’t match the one used to set up SSO.

Do you have a valid SAML certificate (x.509 certificate)?

You can validate your SAML certificate using this SAML validation tool. Note that an expired SAML certificate is also an invalid SAML certificate.

Did you upload a correct SAML certificate (x.509 certificate)?

Confirm that the certificate in the ds:X509Certificate section of the SAML trace matches the one you uploaded to Braze. This doesn’t include the -----BEGIN CERTIFICATE----- header and -----END CERTIFICATE----- footer.

Did you mistype or misformat your SAML certificate (x.509 certificate)?

Confirm that there are no white spaces or extra characters in the certificate that you submitted in the Braze dashboard.

When you enter your certificate into Braze, it needs to be Privacy Enhanced Mail (PEM) encoded and formatted correctly (including the -----BEGIN CERTIFICATE----- header and -----END CERTIFICATE----- footer).

Here is an example certificate that is correctly formatted:

1
2
3
-----BEGIN CERTIFICATE-----
THIS_IS_A_MOCKED_CERTIFICATE_4ysJLTzETANBgkqhkiG9w0BAQsFADA0MTIwMAYDVQQDEylNaWNyb3NvZnQgQXp1cmUgRmVkZXJhdGVkIFNTTyBDZXJ0aWZpY2F0ZTAeFw0yMjA1MjcwOTA4MzFaFw0yNTAbMjcwOTA4MzFaMDQxMjAwBgNVBAMTKU1pY3Jvca9mdCBBenVyZSBGZWRlcmF0ZWQgU1NPIENlcnAFWAOKGPAWIGKJPOAMWANBgkqhkiG9w0BAQEFAAaCAQ8AMIIBCgKCAQEA1+KFJwxoac6jdFztQd+vQu59qM8rgfX5RICk0ODfpXkuDUNudcI0XmOAkKHRoMNPYlmMEf5NSiZ7TMElEPtK9zZlpAoSchxxC0Ndegc1AMFi7i2BsEIqPwrer0G6kx2vuAjdrDROPPafkmwalkfmklaw23FlYmV7doE0Vrj2WxR1PG0eFAdsxPLsO1ny55fPj2ibwaqc0XpDkfTrO9GnFvmZAS8ebYtLZsYAMAGLKWAMLGKAWMLKMFDW6vBDaK290s9FdaWza3GPHTcDstawRhyqbXpVjiqpQ0mtxANW4WduSiohhpeqv05TlSOhx87QalkfmwalfmAWMFLKQEBCwUAA4IBAQBdZ5E9FqICfL1q+G6D1tChKl1Y6I6IVULQb4LESSJRaxv53nakmflwakmMALKFMWOYKAeUWO2hdED54qGMgUnLL6YheQBrsm6ilBC68F7ZFmIzVKycvw65yamWbTMi2f2lF60GNYMrq8sGQUkgO0O2zTN07J9wGTe9M+MAFLKWAMFLKalkmflkawoij4jpcsLXXFZJoHSXnF3+qQuzu+49D6pR2lF7DDW+5+PRoc1QpDSytdXxWzItsjQ6IFRuvIGsbrMg0FVaze7ePdKrc47wSlElno7SQ0H+6g40q25rsDSLO
-----END CERTIFICATE-----

Is the user’s session token valid?

Have the affected user clear their browser’s cache and cookies, and then try to log in with SAML SSO again.

Did you set your RelayState?

If you’re getting the error ERROR_CODE_SSO_INVALID_RELAY_STATE, your RelayState could be misconfigured or nonexistant. If you haven’t already, you need to set your RelayState in your IdP management system. For steps, refer to Setting up your RelayState.

Is the user stuck in a sign-in loop between Okta and Braze?

If a user can’t sign in because they’re stuck cycling between the Okta SSO and Braze dashboard, you need to go to Okta and set the SSO URL destination to your Braze instance (for example, https://dashboard-07.braze.com).

If you’re using another IdP, check if your company uploaded the correct SAML or x.509 certificate to Braze.

Are you using a manual integration?

If your company didn’t download the Braze app from your IdP’s app store, you need to download the pre-built integration. For example, if Okta is your IdP, you’d download the Braze app from their integration page.