Skip to content

Commit 1659341

Browse files
authored
Merge pull request #3435 from ClickHouse/#3431-saml-update
#3431 saml update
2 parents 465e0a4 + 5285cfa commit 1659341

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

docs/cloud/security/saml-sso-setup.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ We recommend setting up a **direct link to your organization** in addition to yo
5858

5959
- Attribute mapping: `email = user.email`
6060

61-
- Direct link to access your organization: `https://console.clickhouse.cloud?connection={organizationid}`
61+
- Direct link to access your organization: `https://console.clickhouse.cloud/?connection={organizationid}`
6262

6363

6464
For specific configuration steps, refer to your specific identity provider below.
@@ -149,7 +149,7 @@ You will configure two App Integrations in Okta for each ClickHouse organization
149149

150150
5. Select a label for the app.
151151

152-
6. Enter the URL as `https://console.clickhouse.cloud?connection={organizationid}`
152+
6. Enter the URL as `https://console.clickhouse.cloud/?connection={organizationid}`
153153

154154
7. Go to the **Assignments** tab and add the group you created above.
155155

@@ -206,7 +206,7 @@ You will configure two App Integrations in Okta for each ClickHouse organization
206206

207207
### Configure Google SAML {#configure-google-saml}
208208

209-
You will configure one SAML app in Google for each organization and must provide your users the direct link (`https://console.clickhouse.cloud?connection={organizationId}`) to bookmark if using multi-org SSO.
209+
You will configure one SAML app in Google for each organization and must provide your users the direct link (`https://console.clickhouse.cloud/?connection={organizationId}`) to bookmark if using multi-org SSO.
210210

211211
<details>
212212
<summary> Create a Google Web App </summary>
@@ -290,7 +290,7 @@ Azure (Microsoft) SAML may also be referred to as Azure Active Directory (AD) or
290290
|---------------------------|-------|
291291
| Identifier (Entity ID) | `urn:auth0:ch-production:{organizationid}` |
292292
| Reply URL (Assertion Consumer Service URL) | `https://auth.clickhouse.cloud/login/callback?connection={organizationid}` |
293-
| Sign on URL | `https://console.clickhouse.cloud?connection={organizationid}` |
293+
| Sign on URL | `https://console.clickhouse.cloud/?connection={organizationid}` |
294294
| Relay State | Blank |
295295
| Logout URL | Blank |
296296

@@ -313,6 +313,33 @@ Azure (Microsoft) SAML may also be referred to as Azure Active Directory (AD) or
313313

314314
</details>
315315

316+
### Configure Duo SAML {#configure-duo-saml}
317+
318+
<details>
319+
<summary> Create a Generic SAML Service Provider for Duo </summary>
320+
321+
1. Follow the instructions for [Duo Single Sign-On for Generic SAML Service Providers](https://duo.com/docs/sso-generic).
322+
323+
2. Use the following Bridge Attribute mapping:
324+
325+
| Bridge Attribute | ClickHouse Attribute |
326+
|:-------------------|:-----------------------|
327+
| Email Address | email |
328+
329+
3. Use the following values to update your Cloud Application in Duo:
330+
331+
| Field | Value |
332+
|:----------|:-------------------------------------------|
333+
| Entity ID | `urn:auth0:ch-production:{organizationid}` |
334+
| Assertion Consumer Service (ACS) URL | `https://auth.clickhouse.cloud/login/callback?connection={organizationid}` |
335+
| Service Provider Login URL | `https://console.clickhouse.cloud/?connection={organizationid}` |
336+
337+
4. Gather these two items and go to Submit a Support Case above to complete the process:
338+
- Single Sign-On URL
339+
- Certificate
340+
341+
</details>
342+
316343

317344
## How It Works {#how-it-works}
318345

@@ -322,19 +349,19 @@ We only utilize service provider initiated SSO. This means users go to `https://
322349

323350
### Assigning User Roles {#assigning-user-roles}
324351

325-
Users will appear in your ClickHouse Cloud console after they are assigned to your IdP application and log in for the first time. At least one SSO user should be assigned the Admin role in your organization. Use social login or `https://console.clickhouse.cloud?with=email` to log in with your original authentication method to update your SSO role.
352+
Users will appear in your ClickHouse Cloud console after they are assigned to your IdP application and log in for the first time. At least one SSO user should be assigned the Admin role in your organization. Use social login or `https://console.clickhouse.cloud/?with=email` to log in with your original authentication method to update your SSO role.
326353

327354
### Removing Non-SSO Users {#removing-non-sso-users}
328355

329-
Once you have SSO users set up and have assigned at least one user the Admin role, the Admin can remove users using other methods (e.g. social authentication or user ID + password). Google authentication will continue to work after SSO is set up. User ID + password users will be automatically redirected to SSO based on their email domain unless users use `https://console.clickhouse.cloud?with=email`.
356+
Once you have SSO users set up and have assigned at least one user the Admin role, the Admin can remove users using other methods (e.g. social authentication or user ID + password). Google authentication will continue to work after SSO is set up. User ID + password users will be automatically redirected to SSO based on their email domain unless users use `https://console.clickhouse.cloud/?with=email`.
330357

331358
### Managing Users {#managing-users}
332359

333360
ClickHouse Cloud currently implements SAML for SSO. We have not yet implemented SCIM to manage users. This means SSO users must be assigned to the application in your IdP to access your ClickHouse Cloud organization. Users must log in to ClickHouse Cloud once to appear in the **Users** area in the organization. When users are removed in your IdP, they will not be able to log in to ClickHouse Cloud using SSO. However, the SSO user will still show in your organization until and administrator manually removes the user.
334361

335362
### Multi-Org SSO {#multi-org-sso}
336363

337-
ClickHouse Cloud supports multi-organization SSO by providing a separate connection for each organization. Use the direct link (`https://console.clickhouse.cloud?connection={organizationid}`) to log in to each respective organization. Be sure to log out of one organization before logging into another.
364+
ClickHouse Cloud supports multi-organization SSO by providing a separate connection for each organization. Use the direct link (`https://console.clickhouse.cloud/?connection={organizationid}`) to log in to each respective organization. Be sure to log out of one organization before logging into another.
338365

339366
## Additional Information {#additional-information}
340367

0 commit comments

Comments
 (0)