SAML SSO セットアップ
SAML SSO is available in the Enterprise plan. To upgrade, visit the Plans page in the cloud console.
ClickHouse Cloud は、セキュリティ アサーション マークアップ言語 (SAML) を介したシングル サインオン (SSO) をサポートしています。これにより、アイデンティティ プロバイダー (IdP) で認証することにより、ClickHouse Cloud 組織に安全にサインインできます。
現在、サービス プロバイダーが開始する SSO、別の接続を使用する複数の組織、およびジャスト イン タイム プロビジョニングをサポートしています。クロス ドメイン アイデンティティ管理 (SCIM) や属性マッピングのシステムはまだサポートしていません。
開始する前に
IdP において管理者権限、ClickHouse Cloud 組織において Admin ロールが必要です。IdP 内で接続を設定した後、以下の手順で要求された情報を持って当社にご連絡ください。
ログインプロセスを簡素化するために、SAML接続に加えて 組織への直接リンク を設定することをお勧めします。各 IdP によってこの処理は異なります。以下に、IdP に対する具体的な手順を示します。
IdP の設定方法
手順
組織 ID を取得する
すべてのセットアップには組織 ID が必要です。組織 ID を取得するには:
-
ClickHouse Cloud 組織にサインインします。
-
左下隅で、Organization の下にある組織名をクリックします。
-
ポップアップメニューで Organization details を選択します。
-
以下で使用するために Organization ID をメモします。
SAML 統合を設定する
ClickHouse はサービス プロバイダーが開始する SAML 接続を使用します。つまり、https://console.clickhouse.cloud または直接リンクを介してログインできます。現在、アイデンティティ プロバイダーが開始する接続はサポートしていません。基本的な SAML 設定には次のものが含まれます:
-
SSO URL または ACS URL:
https://auth.clickhouse.cloud/login/callback?connection={organizationid}
-
Audience URI または Entity ID:
urn:auth0:ch-production:{organizationid}
-
アプリケーションユーザー名:
email
-
属性マッピング:
email = user.email
-
組織へのアクセス用直接リンク:
https://console.clickhouse.cloud/?connection={organizationid}
特定の設定手順については、以下のアイデンティティ プロバイダーに関する情報を参照してください。
接続情報を取得する
アイデンティティ プロバイダーの SSO URL と x.509 証明書を取得します。この情報を取得する方法については、以下の特定のアイデンティティ プロバイダーを参照してください。
サポートケースを提出する
-
ClickHouse Cloud コンソールに戻ります。
-
左の Help を選択し、次に Support サブメニューを選択します。
-
New case をクリックします。
-
件名に「SAML SSO Setup」と入力します。
-
説明に、上記の手順から収集したリンクを貼り付け、チケットに証明書を添付します。
-
この接続を許可するべきドメインもお知らせください(例: domain.com、domain.ai など)。
-
新しいケースを作成します。
-
ClickHouse Cloud 内でセットアップを完了し、テストの準備ができたらお知らせします。
セットアップを完了する
-
アイデンティティ プロバイダー内でユーザーアクセスを割り当てます。
-
https://console.clickhouse.cloud または上記の「SAML 統合の設定」で構成した直接リンクを介して ClickHouse にログインします。ユーザーには最初に「Member」ロールが割り当てられ、組織にログインし、個人設定を更新できます。
-
ClickHouse 組織からログアウトします。
-
元の認証方法でログインし、新しい SSO アカウントに Admin ロールを割り当てます。
- メール + パスワードのアカウントの場合は、
https://console.clickhouse.cloud/?with=email
を使用してください。 - ソーシャルログインの場合は、適切なボタンをクリックしてください (Continue with Google または Continue with Microsoft)
?with=email
内の email
はリテラルのパラメータ値であり、プレースホルダーではありません
-
元の認証方法でログアウトし、再度 https://console.clickhouse.cloud または上記の「SAML 統合の設定」で構成した直接リンクを介してログインします。
-
非 SAML ユーザーを削除して、組織の SAML を強制します。今後はユーザーがアイデンティティ プロバイダーを通じて割り当てられます。
Okta SAML の設定
各 ClickHouse 組織のために、Okta に 2 つのアプリ統合を設定します: SAML アプリと直接リンクを保存するブックマーク。
1. アクセス管理のためにグループを作成する
-
Administrator として Okta インスタンスにログインします。
-
左の Groups を選択します。
-
Add group をクリックします。
-
グループの名前と説明を入力します。このグループは、SAML アプリと関連するブックマークアプリの間でユーザーを一貫性を保つために使用されます。
-
Save をクリックします。
-
作成したグループの名前をクリックします。
-
Assign people をクリックして、この ClickHouse 組織にアクセスさせたいユーザーを割り当てます。
2. ユーザーがシームレスにログインできるようにブックマークアプリを作成する
-
左の Applications を選択し、次に Applications のサブヘディングを選択します。
-
Browse App Catalog をクリックします。
-
Bookmark App を検索して選択します。
-
Add integration をクリックします。
-
アプリのラベルを選択します。
-
URL を
https://console.clickhouse.cloud/?connection={organizationid}
として入力します。 -
Assignments タブに移動し、上記で作成したグループを追加します。
3. 接続を有効にするための SAML アプリを作成する
-
左の Applications を選択し、次に Applications のサブヘディングを選択します。
-
Create App Integration をクリックします。
-
SAML 2.0 を選択し、次に Next をクリックします。
-
アプリケーション名を入力し、Do not display application icon to users の横のボックスにチェックを入れてから Next をクリックします。
-
SAML 設定画面を以下の値で入力します。
フィールド 値 シングルサインオン URL https://auth.clickhouse.cloud/login/callback?connection={organizationid}
Audience URI (SP Entity ID) urn:auth0:ch-production:{organizationid}
デフォルト RelayState 何も入力しない Name ID 形式 指定なし アプリケーションユーザー名 Email アプリケーションユーザー名を更新する 作成して更新 -
以下の Attribute Statement を入力します。
名称 名称形式 値 email Basic user.email -
Next をクリックします。
-
フィードバック画面でリクエストされた情報を入力し、Finish をクリックします。
-
Assignments タブに移動し、上記で作成したグループを追加します。
-
新しいアプリの Sign On タブで View SAML setup instructions ボタンをクリックします。
-
これら 3 つの項目を集め、プロセスを完了するために「サポートケースを提出する」を参照してください。
- アイデンティティ プロバイダーのシングル サインオン URL
- アイデンティティ プロバイダーの発行者
- X.509 証明書
Google SAML の設定
各組織のために Google に 1 つの SAML アプリを設定し、ユーザーにはダイレクトリンク (https://console.clickhouse.cloud/?connection={organizationId}
) をブックマーク用に提供する必要があります。マルチ組織 SSO を使用している場合は必須です。
Google Web アプリを作成する
- Google 管理コンソール (admin.google.com) にアクセスします。
-
左の Apps をクリックし、次に Web and mobile apps をクリックします。
-
上部メニューから Add app をクリックし、次に Add custom SAML app を選択します。
-
アプリの名前を入力し、Continue をクリックします。
-
次の 2 つの項目を集め、「サポートケースを提出する」のステップに進み、情報を送信します。注意:このデータをコピーする前にセットアップを完了した場合は、アプリのホーム画面から DOWNLOAD METADATA をクリックして X.509 証明書を取得します。
- SSO URL
- X.509 証明書
-
以下の ACS URL と Entity ID を入力します。
フィールド 値 ACS URL https://auth.clickhouse.cloud/login/callback?connection={organizationid}
Entity ID urn:auth0:ch-production:{organizationid}
-
Signed response のチェックボックスをオンにします。
-
名称 ID フォーマットに EMAIL を選択し、名称 ID を Basic Information > Primary email. として残します。
-
Continue をクリックします。
-
以下の属性マッピングを入力します:
フィールド | 値 |
---|---|
基本情報 | プライマリメール |
アプリ属性 |
-
Finish をクリックします。
-
アプリを有効にするために、すべてのユーザーに対して OFF をクリックし、設定を ON に変更します。アクセスは、画面左側のオプションを選択することで、グループまたは組織単位に制限することもできます。
Azure (Microsoft) SAML の設定
Azure (Microsoft) SAML は Azure Active Directory (AD) または Microsoft Entra とも呼ばれる場合があります。
Azure エンタープライズ アプリケーションを作成する
各組織のために独自のサインオン URL を持つ 1 つのアプリケーション統合を設定します。
-
Microsoft Entra 管理センターにログインします。
-
左の Applications > Enterprise アプリケーションに移動します。
-
上部メニューの New application をクリックします。
-
上部メニューの Create your own application をクリックします。
-
名前を入力し、Integrate any other application you don't find in the gallery (Non-gallery) を選択してから Create をクリックします。
-
左の Users and groups をクリックし、ユーザーを割り当てます。
-
左の Single sign-on をクリックします。
-
SAML をクリックします。
-
基本的な SAML 設定画面を以下の設定で入力します。
フィールド 値 Identifier (Entity ID) urn:auth0:ch-production:{organizationid}
Reply URL (Assertion Consumer Service URL) https://auth.clickhouse.cloud/login/callback?connection={organizationid}
Sign on URL https://console.clickhouse.cloud/?connection={organizationid}
Relay State 空白 Logout URL 空白 -
属性および請求の下に次の項目を追加 (A) または更新 (U) します:
クレーム名 形式 ソース属性 (U) Unique User Identifier (Name ID) メールアドレス user.mail (A)メール Basic user.mail (U) /identity/claims/name 省略 user.mail -
プロセスを完了するために、上記で「サポートケースを提出する」で参照した 2 つのアイテムを集めます:
- ログイン URL
- 証明書 (Base64)
Duo SAML の設定
Duo 用の汎用 SAML サービス プロバイダーを作成する
-
Duo Single Sign-On for Generic SAML Service Providers の指示に従います。
-
次のブリッジ属性マッピングを使用します:
ブリッジ属性 ClickHouse 属性 メールアドレス email -
Duo のクラウドアプリケーションを更新するために次の値を使用します:
フィールド 値 Entity ID urn:auth0:ch-production:{organizationid}
Assertion Consumer Service (ACS) URL https://auth.clickhouse.cloud/login/callback?connection={organizationid}
サービスプロバイダーログインURL https://console.clickhouse.cloud/?connection={organizationid}
-
プロセスを完了するために、上記で「サポートケースを提出する」で参照した 2 つのアイテムを集めます:
- シングル サインオン URL
- 証明書
動作の仕組み
サービス プロバイダーが開始する SSO
私たちはサービス プロバイダーが開始する SSO のみを利用します。これは、ユーザーが https://console.clickhouse.cloud
に移動し、メールアドレスを入力して IdP にリダイレクトされることを意味します。すでに IdP を通じて認証されたユーザーは、ログインページでメールアドレスを入力することなく組織に自動的にログインするために直接リンクを使用できます。
ユーザーロールの割り当て
ユーザーは IdPアプリケーションに割り当てられ、初めてログインすると、ClickHouse Cloud コンソールに表示されます。少なくとも 1 人の SSO ユーザーに Admin ロールを割り当てる必要があり、SSO でログインする追加のユーザーは "Member" ロールで作成されるため、デフォルトではサービスにアクセスできず、アクセス権とロールは Admin によって更新する必要があります。
社会的なログイン、または https://console.clickhouse.cloud/?with=email を使用して元の認証方法でログインして SSO ロールを更新します。
非 SSO ユーザーの削除
SSO ユーザーを設定し、少なくとも 1 人のユーザーに Admin ロールを割り当てたら、Admin は他の方法 (例: ソーシャル認証やユーザー ID + パスワード) を使用してユーザーを削除できます。Google 認証は、SSO が設定された後も動作し続けます。ユーザー ID + パスワードのユーザーは、そのメールドメインに基づいて SSO に自動的にリダイレクトされますが、ユーザーが https://console.clickhouse.cloud/?with=email を使用しない限りです。
ユーザーの管理
ClickHouse Cloud は現在、SSO に対して SAML を実装しています。ユーザー管理のために SCIM はまだ実装されていません。これは、SSO ユーザーは ClickHouse Cloud 組織にアクセスするために IdP 内のアプリケーションに割り当てる必要があることを意味します。ユーザーは ClickHouse Cloud に一度ログインする必要があり、組織の Users 領域に表示されます。ユーザーが IdP で削除されると、SSO を介して ClickHouse Cloud にログインすることができなくなります。ただし、SSO ユーザーは、管理者が手動でユーザーを削除するまで、組織に表示され続けます。
マルチ組織 SSO
ClickHouse Cloud は、各組織に対して別々の接続を提供することによってマルチ組織 SSO をサポートしています。直接リンク (https://console.clickhouse.cloud/?connection={organizationid}
) を使用して、それぞれの組織にログインします。別の組織にログインする前に、必ず一つの組織からログアウトしてください。
追加情報
認証に関してはセキュリティが最優先事項です。この理由から、SSO の実装時にいくつかの決定を行いましたので、お知らせします。
-
サービス プロバイダーが開始する認証フローのみを処理します。 ユーザーは
https://console.clickhouse.cloud
に移動し、メール アドレスを入力して IdP にリダイレクトされる必要があります。ブックマーク アプリケーションやショートカットを追加する手順が提供されており、ユーザーは URL を覚えておく必要はありません。 -
IdP 経由でアプリに割り当てられたすべてのユーザーは同じメール ドメインを持っている必要があります。 ベンダーや請負業者、コンサルタントが ClickHouse アカウントにアクセスできるようにするには、従業員と同じドメイン (例: [email protected]) のメールアドレスを持たなければなりません。
-
SSO アカウントと非 SSO アカウントは自動的にはリンクされません。 同じメールアドレスを使用している場合でも、ClickHouse ユーザーリストに複数のアカウントが表示される場合があります。