This is an Enterprise feature on Novu Cloud. Configure it as the organization Owner from Settings > Organization > Security after we enable self-serve, or email [email protected] and we will do the Novu side with you. Domain verification and activation are covered in SAML SSO & SCIM.
Before you start
- An Enterprise organization on Novu Cloud.
- One or more email domains verified on the Security tab. The domain has to be the one in the person’s primary email, because Name ID is set to EMAIL. For SAML,
[email protected]matches a connection foracme.com.[email protected]does not, unless we have enabled subdomain matching. - A Google Workspace admin who can add web and mobile apps and change user access.
- The ACS URL and Entity ID from the Security tab when Google Workspace is selected, or from the message we send.
Values to paste into Google
You paste these on the service provider step, which is after you download Google’s metadata. They are not the SSO URL and entity ID that Google shows on the previous screen. Those belong to Google, and you send them back to Novu.
Create the custom SAML app
1
Add a custom SAML app
In the Google Admin console, go to Apps > Web and mobile apps. Select Add app, then Add custom SAML app. Enter an app name and select Continue.
2
Download Google's metadata
On Google Identity Provider details, under Option 1: Download IdP metadata, select Download Metadata. Keep that file. You will upload it on the Security tab, or send it to us.If you cannot use the file, use Option 2 and copy three values instead:
Select Continue only after you have the file, or those three values. Novu cannot finish the connection without Google’s metadata.
3
Enter Novu's service provider details
Paste the ACS URL and Entity ID from Novu into their fields. Under Name ID, set Name ID format to EMAIL. Select Continue.EMAIL means Google puts the person’s primary email in the SAML subject. Leave this on EMAIL. A different Name ID format, such as an opaque ID, does not give Novu an email address to match.
4
Map attributes
Only the primary email is required. The app attribute for email on this Google connection is
email, not mail.Select Finish.
5
Turn the app on
In User access, select ON for everyone, or turn it on only for the organizational units that should use Novu. Select Save.A user in an organizational unit where the app is off cannot sign in, even when SSO is active in Novu and their email domain is verified.
6
Return the metadata to Novu
Upload the metadata file on the Security tab, or send the file to us. If you used Option 2, provide the SSO URL, Google’s entity ID, and the certificate instead.When Google rotates the signing certificate, send the new metadata file or the new certificate before Google stops using the old one. On a live connection, that update applies immediately.
Test it, then turn it on
On the Security tab, run a test sign-in with a Workspace user who can open the app and whose email is on a verified domain. For a new connection, that test does not change sign-in for anyone else. The connection is not live until you activate it.What your users experience
- They start on the Novu sign-in page, enter their work email, and are sent to Google. Google checks their Workspace credentials, then sends them back.
- An existing Novu account with that email is linked to this SAML login. They keep the same account.
- If they also have multi-factor authentication on the Novu account, they still complete that step after Google accepts them. Workspace 2-Step Verification is separate, and Google enforces that before it returns the user.
- Starting from a Google app launcher tile is not part of this setup. Ask us if you need IdP-initiated SAML.
- Removing the connection does not delete Novu accounts.
- Without directory sync, a person is created in Novu the first time they sign in. Google directory sync does not use SCIM. It reads the directory with a service account.
If Google sign-in fails
Google signs them in and Novu has no email
Google signs them in and Novu has no email
Name ID format is not EMAIL, or the primary email is not mapped to the app attribute
email. mail is the Okta and custom SAML name. It is the wrong name on this Google app.The user is in the Workspace directory and still cannot open Novu
The user is in the Workspace directory and still cannot open Novu
User access is off for their organizational unit. Turn the app on for that unit, or move them into a unit where it is on.
The ACS URL was rejected
The ACS URL was rejected
The ACS URL and entity ID from Novu belong on the service provider step. Google’s SSO URL and entity ID, from the previous step, are what you upload or send back. Swapping those two pairs is a common mismatch.
Only the test user is redirected
Only the test user is redirected
Activate the connection after the test succeeds.