18min

Single sign-on

Introduction

The identity federation standard Security Assertion Markup Language (SAML) 2.0 enables the secure exchange of user authentication data between web applications and identity service providers. When you use the SAML 2.0 protocol to enable single sign-on (SSO), security tokens containing assertions pass information about an end user (principal) between a SAML authority - an identity provider (IdP), and a SAML consumer - a service provider (SP). Echoes, acting as the service provider (SP), supports single sign-on through SAML using external identity providers (IdPs) such as Okta, OneLogin and Microsoft Active Directory Federation Service. Echoes is compatible with all external IdPs that support SAML 2.0.

Echoes supports Identity and Service Provider initiated SSO

Default Membership

Every member who creates a new account via SSO will be put into the global Organization with the default Contributor role.

Configuring SSO/SAML

Step 1: Configure your identity provider

Head to the configuration page to get the Echoes SP information to be set into your IDP:

  • Assertion Consumer Service URL: This is the callback that the IdP will send to tell Echoes to log in a user.
  • Entity ID/SAML Audience: A URL that describe the entity that is expected to receive the SAML message. In this case, it is the URL for Echoes.
  • Metadata: Echoes SP metadata file (XML) can be downloaded.

Attributes mapping

Those attribute names are expected and mendatory.

  • FirstName
  • LastName
  • Email

Example of attribute assertion:

XML
|

SAML2 Identity Providers example

  • Okta
  • Keycloak

Step 2: Enable SSO in Echoes

Head to the configuration page in order to enter the SAML information in order to configure the Echoes SP. Two values are to be set:

  • SAML 2.0 Endpoint URL: In most cases it opens your Identity Provider's page where your end-users are to enter their credentials
  • Public Key x.509 Certificate: Issued by your Identity Provider

Once configured, all users holding the email domain from the root Account Owner (root user who opened the Echoes account the very first time) will authenticate using SSO (personal login credentials will no longer work). Users who signup via invites with an email domain different from the root Account Owner will not authenticate using SSO.

If you wish to add more domains to your SSO configuration, please reach out to support@echoeshq.com.

FAQ

What is the process for adding new members to a SAML-enabled Echoes account?

Echoes makes use of Just-In-Time provisioning for member accounts; any new member created within an Identity Provider will have an account automatically created in Echoes when that member attempts to sign into Echoes for the first time.

What happens to Echoes accounts that exist prior to SAML being enabled/enforced?

Existing members will have their Echoes account automatically linked to their IDP account.

Does Echoes deprovision members if they are no longer present in the Identity Provider?

At this time, Echoes's SAML2 integration does not automatically deprovision inactive user accounts. Instead, the member remains inside of Echoes without any means to log in, as they can no longer access the IdP platform for sign-on. For now, inactive member accounts will need to be removed manually by a Manager or an Owner in Echoes.

What is the process for deleting SAML configuration?



Updated 05 Apr 2022
Did this page help you?
Yes
No