Be first to try Soda's new AI-powered metrics observability, and collaborative data contracts.
Try Soda Now!
LogoLogo
  • What is Soda?
  • Quickstart
  • Data Observability
    • Metric Monitoring dashboard
      • Dataset monitors
      • Column monitors
    • Metric monitor page
  • Data Testing
    • Git-managed Data Contracts
      • Install and Configure
      • Create and Edit Contracts
      • Verify a contract
    • Cloud-managed Data Contract
      • Author a Contract in Soda Cloud
      • Verify a contract
  • Onboard datasets on Soda Cloud
  • Manage Issues
    • Organization dashboard
    • Browse Datasets
    • Dataset dashboard
    • Browse Checks
    • Check and dataset attributes
    • Analyze monitor and check results
    • Notifications
    • Incidents
  • Dataset Attributes & Responsibilities
  • Deployment options
    • Deploy Soda Agent
      • Deploy a Soda Agent in a Kubernetes cluster
      • Deploy a Soda Agent in an Amazon EKS cluster
      • Deploy a Soda Agent in an Azure AKS cluster
      • Deploy a Soda Agent in a Google GKE cluster
      • Soda Agent Extra
  • Organization and Admin Settings
    • General Settings
    • User management
    • User And User Group Management with SSO
    • Global and Dataset Roles
    • Integrations
  • Integrations
    • Alation
    • Atlan
    • Metaphor
    • Purview
    • Jira
    • ServiceNow
    • Slack
    • MS Teams
    • Webhook
  • Reference
    • Generate API keys
    • Python API
    • CLI Reference
    • Contract Language Reference
    • Data source reference for Soda Core
    • Rest API
    • Webhook API
Powered by GitBook
On this page
  • Compatibility
  • SSO access to Soda Cloud
  • Add Soda Cloud to Azure AD
  • Add Soda Cloud to Okta
  • Add Soda Cloud to Google Workspace
  • Sync user groups from an IdP
  • Set up user group sync in Azure AD
  • Set up user group sync in Okta

Was this helpful?

Export as PDF
  1. Organization and Admin Settings

User And User Group Management with SSO

PreviousUser managementNextGlobal and Dataset Roles

Last updated 7 days ago

Was this helpful?

Organizations that use a Security Assertion Markup Language (SAML) 2.0 single sign-on (SSO) identity provider (IdP) can add Soda Cloud as a service provider.

Once added, employees of the organization can gain authorized and authenticated access to the organization’s Soda Cloud account by successfully logging in to their SSO. This solution not only simplifies a secure login experience for users, it enables IT Admins to:

  • grant their internal users’ access to Soda Cloud from within their existing SSO solution

  • revoke their internal users’ access to Soda Cloud from within their existing SSO solution if a user leaves their organization or no longer requires access to Soda Cloud

  • set up one-way user group syncing from their IdP into Soda Cloud (tested and documented for Azure Active Directory and Okta)

Compatibility

Soda Cloud is able to act as a service provider for any SAML 2.0 SSO identity provider. In particular, Soda has tested and has written instructions for setting up SSO access with the following identity providers:

Soda has tested and confirmed that SSO setup works with the following identity providers:

  • OneLogin

  • Auth0

  • Patronus

SSO access to Soda Cloud

When an employee uses their SSO provider to access Soda Cloud for the first time, Soda Cloud automatically assigns the new user to roles and groups according to the Global and Dataset Rolesfor any new users. Soda Cloud also notifies the Soda Cloud Admin that a new user has joined the organization, and the new user receives a message indicating that their Soda Cloud Admin was notified of their first login. A Soda Cloud Admin or user with the permission to do so can adjust users’ roles in Organization Settings. See Global and Dataset Roles for details.

When an organization’s IT Admin revokes a user’s access to Soda Cloud through the SSO provider, a Soda Cloud Admin is responsible for updating the resources and ownerships linked to the User.

Once your organization enables SSO for all Soda Cloud users, Soda Cloud blocks all non-SSO login attempts and password changes. If an employee attempts a non-SSO login or attempts to change a password using “Forgot password?”, Soda Cloud presents a message that explains that they must log in or change their password using their SSO provider.

Optionally, you can set up the SSO integration Soda to include a one-way sync of user groups from your IdP into Soda Cloud which synchronizes with each user login to Soda via SSO. Sync user groups from an IdP

Soda Cloud supports both Identity Provider Initiated (IdP-initiated), and Service Provider Initiated (SP-initiated) single sign-on integrations. Be sure to indicate which type of SSO your organization uses when setting it up with the Soda Support team.

Add Soda Cloud to Azure AD

  1. Click Create your own application.

  2. In the right pane that appears, provide a name for your app, such as Soda Cloud, then select the (Non-gallery) option. Click Create.

  3. After Azure AD creates your app, click Single sign-on in the left nav under the Manage heading, then select the SAML tile.

  4. In the Basic SAML Configuration block that appears, click Edit.

  5. In the Basic SAML Configuration panel, there are two fields to populate:

    • Identifier (Entity ID), which is the value of samlUrl from step 1.

    • Reply URL, which is the value of samlUrl from step 1.

  6. Click Save, then close the confirmation message pop-up.

  7. In the User Attributes & Claims panel, click Edit to add some attribute mappings.

  8. Configure the claims as per the following example. Soda Cloud uses familyname and givenname, and maps emailaddress to user.userprincipalname. (Optional) Follow the additional steps to enable one-way user group syncing to your SSO configuration; see Set up user group sync in Azure AD).

  9. Scroll down to collect the values of three fields that Soda needs to complete the Azure AD SSO integration:

    • Azure AD Identifier (Section 4 in Azure). This is the IdP entity, ID, or Identity Provider Issuer that Soda needs

    • Login URL (Section 4 in Azure). This is the IdP SSO service URL, or Identity Provider Single Sign-On URL that Soda needs.

    • X.509 Certificate. Click the Download link next to Certificate (Base64).

    • Soda Cloud supports both Identity Provider Initiated (IdP-initiated), and Service Provider Initiated (SP-initiated) single sign-on integrations; be sure to indicate which type of SSO your organization uses.

    • (Optional) Ask Soda to enable one-way user group syncing to your SSO configuration; see Set up user group sync in Azure AD)

  10. Test the integration by assigning the Soda application in Azure AD to a single user, then requesting that they log in.

  11. After a successful single-user test of the sign in, assign access to the Soda Azure AD app to users and/or user groups in your organization.

Add Soda Cloud to Okta

  1. Select SAML 2.0.

  2. Click Next. In the Configure SAML tab, there are two fields to populate:

    • Single sign on URL, which is the value of samlUrl from step 1.

    • Audience URI (SP Entity ID), which is also the value of samlUrl from step 1. The values for these fields are unique to your organization and are provided to you by Soda and they follow this pattern: https://cloud.soda.io/sso/<your-organization-identifier>/saml.

  3. Be sure to use an email address as the application username.

  4. Scroll down to Attribute Statements to map the following values, then click Next to continue.

    • map User.GivenName to user.firstName

    • map User.FamilyNameto user.lastName

    • map User.Email to user.email

    • (Optional) Follow the additional steps to enable one-way user group syncing to your SSO configuration; Set up user group sync in Okta.

  5. Select the following options, then click Finish.

    • I’m an Okta customer adding an internal app.

    • This is an internal app that we have created.

  6. In the Sign On pane of the application, scroll down to click View Setup Instructions.

  7. Collect the values of three fields that Soda needs to complete the Okta SSO integration:

    • Identity Provider Single Sign-On URL

    • Identity Provider Issuer

    • X.509 Certificate

    • Soda Cloud supports both Identity Provider Initiated (IdP-initiated), and Service Provider Initiated (SP-initiated) single sign-on integrations; be sure to indicate which type of SSO your organization uses.

    • (Optional) Ask Soda to enable one-way user group syncing to your SSO configuration; see Set up user group sync in Okta.

  8. Test the integration by assigning the Soda application in Okta to a single user, then requesting that they log in.

  9. After a successful single-user test of the sign in, assign access to the Soda Okta app to users and/or user groups in your organization.

Add Soda Cloud to Google Workspace

  1. On the Google Identity Provider details page, be sure to copy or download the following values:

    • SSO URL

    • Entity ID

    • IDP metadata

    • Certificate

  2. On the SAML Attribute mapping page, add two Google directory attributes and map as follows:

    • Last Name → User.FamilyName

    • First Name → User.GivenName

Sync user groups from an IdP

If you wish, you can choose to regularly one-way sync the user groups you have defined in your IdP into Soda Cloud.

  • Soda synchronizes user groups with the IdP every time a user in your organization logs in to Soda via SSO. Soda updates the user’s group membership according to the IdP user groups to which they belong at each log in.

  • You cannot manage IdP user group settings or membership in Soda Cloud. Any changes that you wish to make to IdP-managed user groups must be done in the IdP itself.

Set up user group sync in Azure AD

    • For the choice of which groups should be returned in the claim, best practice suggests selecting Groups assigned to the application.

  1. In your message to Soda Support or your Soda Customer Engineer, advise Soda that you wish to enable user group syncing. Soda adds a setting to your SSO configuration to enable it.

  2. When the SSO integration is complete, you and your team can select your IdP user groups from the dropdown list of choices available when assigning ownership or permissions to resources.

Set up user group sync in Okta

    • For the Name value, use Group.Authorization.

    • Leave the optional Name Format value as Unspecified.

  1. Use the Add Another button to add as many groups as you wish to make available in Soda Cloud.

  2. In your message to Soda Support or your Soda Customer Engineer, advise Soda that you wish to enable user group syncing. Soda adds a setting to your SSO configuration to enable it.

  3. When the SSO integration is complete, you and your team can select your IdP user groups from the dropdown list of choices available when assigning ownership or permissions to resources.

Email to request SSO set-up for Soda Cloud and provide your Soda Cloud organization identifier, accessible via your avatar > Organization Settings, in the Organization tab. Soda Support sends you the samlUrl that you need to configure the set up with your identity provider.

As a user with sufficient privileges in your organization’s Azure AD account, sign in through , then navigate to Enterprise applications. Click New application.

Email the copied and downloaded values to . With those values, Soda completes the SSO configuration for your organization in cloud.soda.io and notifies you of completion.

Email to request SSO set-up for Soda Cloud and provide your Soda Cloud organization identifier, accessible via your avatar > Organization Settings, in the Organization tab. Soda Support sends you the samlURL that you need to configure the set up with your identity provider.

As an Okta Administrator, log in to Okta and navigate Applications > Applications overview, then click Create App Integration. Refer to for full procedure.

Provide a name for the application, Soda Cloud, and upload the .

Email the copied and downloaded values to . With those values, Soda completes the SSO configuration for your organization in cloud.soda.io and notifies you of completion.

Email to request SSO set-up for Soda Cloud and provide your Soda Cloud organization identifier, accessible via your avatar > Organization Settings, in the Organization tab. Soda Support sends you the samlURL that you need to configure the set up with your identity provider.

As an administrator in your Google Workspace, follow the instructions in to Set up your own custom SAML application.

Optionally, upload the so it appears in the app launcher with the logo instead of the first two letters of the app name.

Email the copied and downloaded values to . With those values, Soda completes the SSO configuration for your organization in cloud.soda.io and notifies you of completion. Soda Cloud supports both Identity Provider Initiated (IdP-initiated), and Service Provider Initiated (SP-initiated) single sign-on integrations; be sure to indicate which type of SSO your organization uses.

In the Google Workspace admin portal, use Google’s instructions to and verify that SSO works with the new custom app for Soda.

Doing so obviates the need to manually create user groups in Soda Cloud that you have already defined in your IdP, and enables your team to select an IdP-managed user groups when assigning ownership access permissions to a resource, in addition to any user groups you may have created manually in Soda Cloud. See:

Soda has tested and documented one-way syncing of user groups with Soda Cloud for Okta and Azure Active Directory. to request tested and documented support for other IdPs.

In step 10 of the SAML application setup procedure , in the same User Attributes & Claims section of your Soda SAML Application in Azure AD, follow to add a group claim to your Soda SAML Application.

For the choice of Source attribute, select Cloud-only group display names.

After saving the group claim, navigate to Users and Groups in the left menu, and follow Microsoft’s instructions to . Add any existing groups to the Soda SAML Application that you wish to make available in Soda Cloud to manage access and permissions.

In step 7 of the SAML application integration procedure , follow Okta’s instructions to .

Use the Filter to find a group that you wish to make available in Soda Cloud to manage access and permissions. Exercise caution! A broad filter may include user groups you do not wish to include in the sync. Double-check that the groups you select are appropriate.

Azure Active Directory
Okta
Google Workspace
support@soda.io
portal.azure.com
support@soda.io
support@soda.io
Okta documentation
Soda logo
support@soda.io
support@soda.io
Google Workspace documentation
Soda logo
support@soda.io
Turn on your SAML app
Contact Soda
above
Microsoft’s instructions
Assign a user or group to an enterprise application
above
Define group attribute statements
User Groups