This document serves as a comprehensive overview on how to configure your Single Sign-On (SSO) and SAML authentication on Voiceflow, and manage your member access.
With Voiceflow's SAML authentication support, Enterprise customers are able to manage access to their organization's workspace. All access will be provisioned using your chosen identity management provider, and that will be used to dictate who can Sign Up and Sign In to Voiceflow.
Voiceflow supports SAML 2.0 authentication through either an SP or IdP initiated flow.
- SP is Service Provider (i.e. Voiceflow)
- IdP is Identity Provider (i.e. Okta or a custom SAML implementation)
Here are the overall steps required to configure your SAML instance:
- Once SAML has been enabled for your organization (see next section, if not done), you will find the configuration menu (see above screenshot) under Workspace Settings on your workspace.
- On your identity provider, you will need to input the Audience URI and ACS/Callback URL links listed in the Authentications settings.
- From your identify provider setup, copy and paste the Entity ID URL and IdP SSO Target URL.
- From your identity provider, copy and paste the X.509 certificate content into the field provided.
- Once your configuration is saved and validated, SAML SSO is now enabled. Through your Identity provider dashboard, you can now log in to Voiceflow.
Enabling SAML on Voiceflow:
Ensure you are on a Voiceflow Enterprise plan. Contact your Voiceflow Customer Success Manager to flag all relevant workspaces as part of an organization, and ensure anyone configuring SAML/SSO settings is an admin of the workspace.
Once everything is filled out and saved, an IdP-initiated login flow should be possible for the admin.
- To retroactively add existing Voiceflow accounts to SAML, contact your Voiceflow Customer Success manager.
- For an SP-initiated login flow, contact your Voiceflow Customer Success manager to flag a specific email domain name. This is done for verification and security purposes.
Whenever a login is detected with the email domain, the user will be prompted to Log In via SSO.
Audience URI (SP Entity ID)
Assertion Consumer Service URL / Callback URL - The endpoint where the IdP will redirect with its authentication response + Email Identifier
Entity ID URL
IdP SSO Target URL - The URL users of your organization will be directed to on login via an SP initiated flow (optional)
*On the IdP side, you will need to send the Email identifier (
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress) to uniquely identify SSO users
Once the initial setup is complete, domains can be whitelisted. This will ensure that users with email addresses containing these domains will be directed to your SAML authentication
- Provide your Voiceflow Customer Success Rep with a list of domains that will be whitelisted for your SAML auth. Note: You may configure more than one domain if your organization requires it - ex. voiceflow.com and getvoiceflow.com
- We can enable SAML authentication, and once enabled, all users on your domains will only be able to access Voiceflow using your SSO.
Microsoft Azure mappings
Attribute and Claims → leave default
|Audience URI (SP Entity ID)||Identifier (EntityID)||VF → Azure||https://voiceflow.com|
|ACS/Callback URL||Reply URL (Assertion Customer Service URL)||VF → Azure||https://api.<something>.voiceflow.com/|
|Entity ID URL||Azure ID Identifier||Azure → VF||https://sts.windows.net/……|
|IdP SSO Target URL||Login URL||Azure → VF||https://login.microsoftonline.com/……|
|X.509 Certificate||Certificate (Base64)||Azure → VF||
—Begin Certificate ——- ……
Common SAML/SSO Questions
- Is this an SP or IdP initiated flow? If SP initiated, what is the SP login URL?
Voiceflow supports SAML 2.0 authentication through either an SP or IdP initiated flow. SP is Service Provider, i.e. Voiceflow, and IdP is Identity Provider, i.e. Okta or a custom SAML implementation.
- What is the application username format (e.g. email address or user ID)?
It is the customers' (your) email address domain.
- What additional attributes need to be included in the SAML assertion?
- Entity ID URL
- IdP SSO Target URL - The URL users of your organization will be directed to on login via an SP initiated flow (optional)
- X.509 certificate
- How are group/role membership mapped? Is it 1 user –to –1 group, or 1 user –to –many groups?
- Voiceflow SSO only uses SSO for authentication purposes - not authorization. Therefore no mapping is done.
Can the application reference IdP metadata URL? If not, can it reference an XML file?
- Yes. Voiceflow provides:
- Audience URI (SP Entity ID)
- Assertion Consumer Service URL / Callback URL - The endpoint where the IdP will redirect with its authentication response + Email Identifier urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Please note: Voiceflow expects:
SAML name identifier from your identity provider as a part of the SAML authentication response in order to uniquely identify SSO users on our platform. Authorization is handled internally within the Voiceflow platform based on assigned user roles.
- Yes. Voiceflow provides:
Can the application store multiple IdP SAML certificates at once?Yes, with multiple domains.
How are users created, updated, and removed in the application?The Voiceflow Workspace Owners are the able to perform user management on the organization's users
Is Basic Auth currently available? Once SSO is in enabled, will Basic Auth be disabled?It is recommended Basic Auth be disabled once SSO is enabled. Basic Auth is disabled when SSO is enabled.
Is there an admin back door, in case SSO is down?Voiceflow administrators can access without SSO
Is there SSO integration documentation for the application?
- Yes, found here.