Before you begin
You will need Admin permissions in your IdP, the ability to add a TXT record to the DNS settings for your domain, the Admin role in your ClickHouse Cloud organization. We recommend setting up a direct link to your organization in addition to your SAML connection to simplify the login process. Each IdP handles this differently. Read on for how to do this for your IdP.How it works
Once SAML SSO is configured, users sign in through a service-provider-initiated flow:- The user goes to
https://console.clickhouse.cloudand enters their email address (or uses your organization’s direct link). - ClickHouse Cloud redirects them to your identity provider to authenticate.
- On success, the identity provider redirects them back to ClickHouse Cloud.
- ClickHouse Cloud signs them in, provisioning the account just-in-time on first login and assigning your configured default role.
How to configure your IdP
Access Organization settings
Enable SAML single sign-on
Enable SAML single sign-on. Leave this screen open as you will refer back to it several times during the setup process.Create an application in your identity provider
Enable SAML single sign-on screen to your identity provider configuration. For more information on this step, refer to your specific identity provider below.Add the metadata URL to your SAML configuration
Metadata URL from your SAML provider. Return to ClickHouse Cloud, click Next: Provide metadata URL and paste the URL in the text box.Get domain verification code
Next: Verify your domains. Enter your domain in the text box and click Check domain. The system will generate a random verification code for you to add to a TXT record with your DNS provider.Verify your domain
TXT record name to the TXT record Name field with your DNS provider. Copy the Value to the Content field with your DNS provider. Click Verify and Finish to complete the process.Update default role and session timeout
Configure your admin user
- Log out of ClickHouse Cloud.
- In your identity provider, assign the admin user to the ClickHouse applications.
- Ask the user to log in via https://console.clickhouse.cloud/?connection={orgId} (shortcut URL). This may be via a bookmark you created in the prior steps. The user won’t appear in ClickHouse Cloud until their first login.
- If the default SAML role is anything other than Admin, the user may need to log out and log back in with their original authentication method to update the new SAML user’s role.
- For email + password accounts, please use
https://console.clickhouse.cloud/?with=email. - For social logins, please click the appropriate button (Continue with Google or Continue with Microsoft)
- For email + password accounts, please use
email in ?with=email above is the literal parameter value, not a placeholder- Log out one more time and log back in via the shortcut URL to complete the last step below.
Remove other authentication methods
Configure your identity provider
- Okta
- Google
- Azure (Microsoft)
- Duo
Create a group to manage access
- Log in to your Okta instance as an Administrator.
- Select Groups on the left.
- Click Add group.
- Enter a name and description for the group. This group will be used to keep users consistent between the SAML app and its related bookmark app.
- Click Save.
- Click the name of the group that you created.
- Click Assign people to assign users you would like to have access to this ClickHouse organization.
Create a bookmark app to enable users to seamlessly log in
- Select Applications on the left, then select the Applications subheading.
- Click Browse App Catalog.
- Search for and select Bookmark App.
- Click Add integration.
- Select a label for the app.
- Enter the URL as
https://console.clickhouse.cloud/?connection={organizationid} - Go to the Assignments tab and add the group you created above.
Create a SAML app to enable the connection
- Select Applications on the left, then select the Applications subheading.
- Click Create App Integration.
- Select SAML 2.0 and click Next.
- Enter a name for your application and check the box next to Don’t display application icon to users then click Next.
-
Use the following values to populate the SAML settings screen.
-
Enter the following Attribute Statement.
- Click Next.
- Enter the requested information on the Feedback screen and click Finish.
- Go to the Assignments tab and add the group you created above.
- On the Sign On tab for your new app, click the Copy metadata URL button.
- Return to Add the metadata URL to your SAML configuration to continue the process.
Troubleshooting
There could be a misconfiguration in the system or a service outage
There could be a misconfiguration in the system or a service outage
https://console.clickhouse.cloud/?connection={organizationid}. Follow the instructions for your identity provider above to make this the default login method for your users.You're directed to your identity provider, then back to the login page
You're directed to your identity provider, then back to the login page
User isn't assigned to this application
User isn't assigned to this application
You always land in the same organization with multiple SAML orgs
You always land in the same organization with multiple SAML orgs
The URL briefly shows access denied
The URL briefly shows access denied
Frequently asked questions
Does ClickHouse Cloud support identity-provider-initiated sign-in?
Does ClickHouse Cloud support identity-provider-initiated sign-in?
https://console.clickhouse.cloud and enter their email to be redirected to your identity provider. Set up a bookmark or direct link (https://console.clickhouse.cloud/?connection={organizationid}) so users don’t have to remember the URL.How do I use SAML SSO with multiple organizations?
How do I use SAML SSO with multiple organizations?
https://console.clickhouse.cloud/?connection={organizationid}) to log in to each one, and log out of one organization before logging into another. If you don’t want users on your domain routed to an organization automatically when they enter their email at https://console.clickhouse.cloud, open a support ticket to remove that behavior.Why do I see multiple accounts for the same user?
Why do I see multiple accounts for the same user?
Next steps
- Manage cloud users — manage permissions and restrict access to SAML connections only.
- SCIM provisioning — automate user and group provisioning (private preview).
- Console roles and permissions — the roles you can assign as the default SAML role.