How to Configure SSO
Secure your account and make registering easy with Single Sign-On.
BrandTV supports Single Sign-On (SSO) for organizations utilizing Security Assertion Markup Language (SAML) 2.0 and OpenID Connect (OIDC) and OAuth 2.0 for easy, secure authentication into the platform. SSO can be set up for Admins and other users logging into their Brandlive Platform account or for attendees logging into a public site. Follow the instructions below to set up SSO for either use case.
First, we'll show you how to configure the integration based on the method of authorization, then how to enable it to use for your projects.
Using SAML 2.0
Step 1: First, you'll configure a SAML integration with help from your IT department.
Settings
Single Sign-On URL: https://sso.brandlive.cloud/saml2/idpresponse
Audience URI (SP Entity ID): urn:brandlive:identity:sp
Attribute Statements: These values will depend on your SSO configuration. Mark them down as they will need to be inserted into the Streams platform.
- Email (required)
- First Name (optional)
- Last Name (optional)
Settings Example
Attributes Example
Step 2: Link your BrandTV channel to your SAML integration.
Navigate to the Settings menu by clicking the gear icon in the top right corner; Select Integrations from the side panel.
Finally, find the SAML integration card and click configure.
Step 3: Configure SAML for your channel
- XML URL: Metadata XML URL for the SAML integration created in step 1. This should be auto-generated when you create the integration.
- Login Button Text: The text you would like displayed on your Login Button
- Attribute Mapping: This should match the attribute mappings created in step 1.
- Upload Image (Optional): Image displayed on Login Button
Once the SAML configuration is complete and turned on, you will be able to add it to any of your projects in the registration settings.
Using OIDC
Step 1: Configure an OIDC integration with help from your IT department.
Settings
- Application Type: Web
- Grant Type: Authorization Code
- Sign-in Direct: https://sso.brandlive.cloud/oauth/oidc (This can be added to the list if you already have an OIDC integration)
Please note the following information from your OIDC integration:
- OIDC Issuer (URL)
- Client ID
- Client Secret
- Attribute Names
Step 2: Link your Streams channel to your OIDC integration.
Navigate to the Settings menu by clicking the gear icon in the top right corner; Select Integrations from the side panel.
Finally, find the OIDC integration card and click configure.
Step 3: Configure OIDC for your channel.
- OIDC Issuer: Value noted in Step 1
- Client ID: Value noted in Step 1
- Client Secret: Value noted in Step 1
- Login Button Text: The text you would like displayed on your Login Button
- Attribute Mapping Email (Required), First Name (optional), Last Name (optional): These values will depend on your OIDC service. Please contact your IT department for the proper values.
- Upload image (optional): Image displayed on Login Button
Once the OIDC configuration is complete and turned on, you will be able to add it to any of your projects in the registration settings.
Using OAuth 2
Step 1: Configure an OAuth 2 integration with help from your IT department.
Although we generally suggest using OIDC first in place of OAuth2 flows for ease of use and setup, Brandlive does offer options for users who would like to use OAuth SSO flows instead.
Settings
- Application Type: Web
- Grant Type: Authorization Code
- Sign-in Direct: https://brandlive-prod.auth.us-west-2.amazoncognito.com/oauth2/idpresponse (This can be added to the list if you already have an OAuth 2 integration)
Please note the following information from your OAuth 2 integration:
- Client ID
- Client Secret
- Authorization Server URL
- Token Server URL
- Resource Server URL
- Logout URL
- Login Button Text
- Scopes
- Attribute Names
- Custom Query Parameters
- Upload Image
Step 2: Link your Streams channel to your OAuth 2 integration.
Navigate to the Settings menu by clicking the gear icon in the top right corner; Select Integrations from the side panel.
Finally, find the OAuth 2 integration card and click configure.
Step 3: Configure OAuth 2 for your channel.
- Client ID: Value noted in Step 1
- Client Secret: Value noted in Step 1
- Authorization Server URL: Value noted in Step 1
- Token Server URL: Value noted in Step 1
- Resource Server URL: Value noted in Step 1
- Logout URL: Value noted in Step 1
- Login Button Text: The text you would like displayed on your Login Button
- Scopes: Value noted in Step 1
- Attribute Mapping Email (Required), First Name (optional), Last Name (optional): These values will depend on your OAuth 2 service. Please contact your IT department for the proper values.
- Custom Query Parameter: Your custom query parameters will be appended to the authorization server URL when an attendee is redirected to sign in.
- Upload image (optional): Image displayed on Login Button
Step 4: Sign-in Redirect URL
In your backend system you will likely need to provide a Sign-in redirect URL, which will be your channel URL (custom or otherwise) with /SSO-redirect at the end. For example, example.brandlive.com/SSO-redirect.
Once the OAuth 2 configuration is complete and turned on, you will be able to add it to any of your projects in the registration settings.
See the section titled "Enabling SSO" below to make SSO available for your users.
Comments
Please sign in to leave a comment.