Skip to main content

SSO (Single Sign On) Configuration

  • Updated
Important - This setup guide is intended for IT system administrators. While we can help you set up SSO to work with our platform, we can't provide support for the configuration of your SAML identity provider.

The Hub provides Single Sign-On (SSO) functionality for enterprise customers, allowing authorised users to access the platform via a single identity, without the need for separate logins and passwords. This allows IT administrators to better manage team access and keeps information more secure.

At present, SSO is a request-only feature, so if you would like to have it enabled on your account, please contact support by clicking the Contact Support | submit a request link at the very top of the page and our team can arrange that for you. If you already have the feature enabled, let's walk through how to get it set up:

  • Step 1 | How to configure Single Sign On (SSO) with your Identity Provider
  • Step 2 | How to configure the Hub to use Single Sign On (SSO)
  • Frequently Asked Questions (FAQs)

Before you get started

You'll need to meet certain criteria before you can configure SSO:

  • An identity provider that supports the SAML 2.0 standard.
  • User permissions that allow you to configure applications within your identity provider.
  • Administrator user credentials for the Hub parent account.

Step 1 | Configuring your SSO Identity Provider

We use SAML 2.0 (Security Assertion Markup Language), a standard that permits Identity Providers (IdP) to safely pass authorisation credentials, such as your username and password, to service providers like the Hub.

1. The first step is to create a new SAML application with your IdP:

2. Configure the application using the following settings:

● For Microsoft Azure AD

MICROSOFT AZURE AD
Audience URI (SP Entity ID) https://app.smsbroadcast.com.au
Single Sign-On URL https://app.smsbroadcast.com.au/login/sso
Assertion Consumer Service URL (Reply URL) https://api.messagemedia.com/v2/iam/sso/acs

 

MICROSOFT AZURE AD | Claim
NAME TYPE VALUE
Unique Iser Identifier (Name ID) SAML user.userprincipalname

 

MICROSOFT AZURE AD | Additional Claim
NAME TYPE VALUE
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress SAML user.mail
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname SAML user.givenname
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name SAML user.userprincipalname
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname SAML user.surname

 

● For Okta

OKTA
Audience URI (SP Entity ID) https://app.smsbroadcast.com.au
Single Sign-On URL (Assertion Consumer Service URL (Reply URL)) https://api.messagemedia.com/v2/iam/sso/acs

 

OKTA | Attributes
NAME NAME FORMAT VALUE
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress URI Reference user.email
http://schemas.microsoft.com/claims/authnmethodsreferences URI Reference session.amr
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname URI Reference user.firstName
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname URI Reference user.lastName

3. Configure a logo - this is optional.

4. Assign users or groups to the application.

5. Copy or download the IdP XML metadata - put this somewhere safe as you'll need this for Step 5 of Configuring the Hub.

RETURN TO TOP

Step 2 | Configuring the Hub

1. Log into the parent account in the Hub - remember, your user credentials will need admin-level access to proceed from here!

Account

2. Once you're logged into the Hub, go to the menu and click on  Menu  Settings, then select Account:

Nav_Settings_Account_01.jpg

Note - if you can't see the Single Sign-on (SSO) option , don't sweat it... it hasn't moved, it just means that the feature isn't enabled on your account. Just reach out to the support team by clicking the Contact Support | submit a request link at the very top of the page.

SSO

3. Select the Security tab.

4. Configure the email domains that you want to enable for SSO - email domains can only be used once per account hierarchy so if you set an email domain at a sub-account level, you can't set the same email domain on another sub-account.

5. Use the dropdown arrow to select your Identity Provider (IdP) - either Okta or Azure AD.

Note - if your IdP is not listed, you can contact the support team to chat more about extending SSO support to your IdP, just click the Contact Support | submit a request link at the very top of the page.

6. Enter the XML provided by your IdP in the field provided.

7. When someone logs into the Hub using SSO but they don't already have a user profile, you can allow the Hub to automatically create a new user with the credentials provided by the IdP. Just toggle this switch to On to enable.

8. Use the dropdown arrow to set the default user role to be assigned to these newly created profiles.

9. Select the accounts & sub-accounts you want to allow these new users to have access to.

10. Toggling this switch to On means that any users logging in with credentials matching your nominated email domains will be forced to log into the Hub using SSO only.

RETURN TO TOP

FAQs

  • My organization uses an identity service provider (IdP) that's not in the list. Will it be supported?
    Please contact the support team with the details of which identity provider you would like to use.
  • Do you support on-premises Microsoft Active Directory?
    No, we only support Azure Active Directory.
  • Do you support IdP initiated SSO?
    Unfortunately not at this stage. Users will need to re-enter their email address in the Login with Single Sign On page.
  • Does enforcing SAML SSO log out users?
    No, active user sessions stay logged in until they expire. The next time a user needs to log in, they will need to log in with SAML SSO.
  • What version of SAML does the Hub support?
    We currently support SAML v2.0.
  • Can I still log into the Hub if my identity provider is experiencing an outage?
    If you have Enforce SAML authentication turned on and your IDP is down, you should contact the support team and we can turn off “Enforce SAML” to allow administrators and users that existed beforehand to login with email again.
    Note - If you get stuck, please reach out to our customer support team via live chat by clicking the profile icon at the bottom left of your screen (in the Hub) and selecting Chat with Support, or you can raise a ticket via the Contact Support | submit a request link at the very top of this page
RETURN TO TOP

 

Related articles