Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

SAML SSO の設定

Enterpriseプランの機能

SAML SSO Enterpriseプランで利用できます。アップグレードするには、Cloud Console のプランページにアクセスしてください。

ClickHouse Cloud は、Security Assertion Markup Language (SAML) によるシングルサインオン (SSO) をサポートしています。これにより、アイデンティティプロバイダー (IdP) で認証することで、ClickHouse Cloud 組織に安全にサインインできます。

サービスプロバイダー開始型 SSO、個別の connection を使用する複数の組織、ならびにジャストインタイムプロビジョニングをサポートしています。また、Okta および Microsoft Entra ID を使用した SCIM Provisioning もサポートしています。現時点では、属性マッピングには対応していません。

SAML インテグレーションを有効にすると、新規ユーザーに割り当てるデフォルトのロールを指定したり、セッションタイムアウトの設定を調整したりすることもできます。

始める前に

IdP での管理者権限、自身のドメインの DNS 設定に TXT レコードを追加する権限、そして ClickHouse Cloud 組織での Admin ロールが必要です。ログイン手順を簡略化するため、SAML 接続に加えて、組織への直接リンクを設定することをおすすめします。この設定方法は IdP ごとに異なります。お使いの IdP での設定方法については、このまま読み進めてください。

仕組み

SAML SSO を設定すると、ユーザーはサービスプロバイダー開始型のフローでサインインします。

  1. ユーザーは https://console.clickhouse.cloud にアクセスし、メールアドレスを入力します (または、組織の直接リンクを使用します) 。
  2. ClickHouse Cloud は認証のため、ユーザーをアイデンティティプロバイダーにリダイレクトします。
  3. 認証が成功すると、アイデンティティプロバイダーはユーザーを ClickHouse Cloud にリダイレクトします。
  4. その後、ユーザーは ClickHouse Cloud にサインインし、初回ログイン時にアカウントがジャストインタイムでプロビジョニングされ、設定したデフォルトロールが割り当てられます。

このガイドの残りでは、一回限りの設定について説明します。

IdP の設定方法

組織設定にアクセスする

左下にある組織名をクリックし、[Organization details] を選択します。

SAMLシングルサインオンを有効にする

Enable SAML single sign-on の横にあるトグルをクリックします。セットアップ中にこの画面を何度か参照するため、このまま開いておいてください。

SAMLセットアップを開始

ID プロバイダーにアプリケーションを作成する

ID プロバイダー内にアプリケーションを作成し、Enable SAML single sign-on 画面に表示される値を ID プロバイダーの設定にコピーしてください。この手順の詳細については、以下の該当する ID プロバイダーの説明を参照してください。

ID プロバイダーのアプリケーションを作成する

メタデータURLをSAML設定に追加する

SAMLプロバイダからMetadata URLを取得します。ClickHouse Cloudに戻り、Next: Provide metadata URLをクリックして、URLをテキストボックスに貼り付けます。

メタデータURLを追加

ドメイン検証コードを取得する

Next: Verify your domains をクリックします。テキストボックスにドメインを入力し、Check domain をクリックします。DNS プロバイダで TXT レコードに追加するためのランダムな検証コードが生成されます。

検証するドメインを追加

ドメインを確認する

DNSプロバイダーでTXTレコードを作成します。TXT record name を、DNSプロバイダー側のTXTレコードのNameフィールドにコピーします。Value を、DNSプロバイダー側のContentフィールドにコピーします。Verify and Finish をクリックして、手順を完了します。

ドメインを確認する

デフォルトのロールとセッションタイムアウトを更新

SAML の設定が完了したら、すべてのユーザーにログイン時に割り当てるデフォルトのロールを設定し、セッションタイムアウトも調整できます。割り当て可能なシステムロールの一覧については、Console のロールと権限を参照してください。

管理者ユーザーを設定する

SAML 経由で最初の管理者ユーザーを割り当てるには、次の手順に従います。

  1. ClickHouse Cloud からログアウトします。
  2. ID プロバイダーで、管理者ユーザーを ClickHouse アプリケーションに割り当てます。
  3. ユーザーに https://console.clickhouse.cloud/?connection={orgId} (ショートカット URL) からログインしてもらいます。前の手順で作成したブックマークからアクセスしてもかまいません。ユーザーは初回ログインするまで ClickHouse Cloud に表示されません。
  4. デフォルトの SAML ロールが Admin 以外の場合は、新しい SAML ユーザーのロールを更新するために、いったんログアウトしてから元の認証方式で再度ログインする必要がある場合があります。
    • メール + パスワードのアカウントの場合は、https://console.clickhouse.cloud/?with=email を使用してください。
    • ソーシャルログインの場合は、該当するボタン (Continue with Google または Continue with Microsoft) をクリックしてください。
  1. もう一度ログアウトし、以下の最後の手順を完了するためにショートカット URL から再度ログインします。

他の認証方式を削除する

インテグレーションを完了するには、SAML 以外の方式を使用しているユーザーをすべて削除し、アクセスを identity provider connection に由来するユーザーのみに制限します。

アイデンティティプロバイダーを設定する

Okta では、ClickHouse の各組織ごとに 2 つの App Integration を設定します。1 つは SAML アプリ、もう 1 つは 直接リンク を保持するためのブックマークです。

アクセス管理用のグループを作成する

  1. Administrator として Okta インスタンスにログインします。
  2. 左側で Groups を選択します。
  3. Add group をクリックします。
  4. グループの名前と説明を入力します。このグループは、SAML アプリと関連するブックマークアプリの間でユーザーを一致させるために使用します。
  5. Save をクリックします。
  6. 作成したグループ名をクリックします。
  7. Assign people をクリックし、この ClickHouse 組織へのアクセスを許可するユーザーを割り当てます。

ユーザーがシームレスにログインできるようにブックマークアプリを作成する

  1. 左側で Applications を選択し、次に Applications サブ見出しを選択します。
  2. Browse App Catalog をクリックします。
  3. Bookmark App を検索して選択します。
  4. Add integration をクリックします。
  5. アプリのラベルを選択します。
  6. URL に https://console.clickhouse.cloud/?connection={organizationid} を入力します
  7. Assignments タブに移動し、上で作成したグループを追加します。

接続を有効にするための SAML アプリを作成する

  1. 左側で Applications を選択し、次に Applications サブ見出しを選択します。

  2. Create App Integration をクリックします。

  3. SAML 2.0 を選択し、Next をクリックします。

  4. アプリケーション名を入力し、Don't display application icon to users の横にあるチェックボックスをオンにしてから Next をクリックします。

  5. 次の値を使用して SAML 設定画面を入力します。

    フィールド
    Single Sign On URL コンソールから Single Sign-On URL をコピーします
    Audience URI (SP Entity ID) コンソールから Service Provider Entity ID をコピーします
    Default RelayState 空欄のままにします
    Name ID format Unspecified
    Application username Email
    Update application username on Create and update
  6. 次の Attribute Statement を入力します。

    Name Name format Value
    email Basic user.email
  7. Next をクリックします。

  8. Feedback 画面で必要な情報を入力し、Finish をクリックします。

  9. Assignments タブに移動し、上で作成したグループを追加します。

  10. 新しいアプリの Sign On タブで、Copy metadata URL ボタンをクリックします。

  11. Add the metadata URL to your SAML configuration に戻り、手順を続けます。

トラブルシューティング

システムの設定ミス、またはサービス障害の可能性があります

原因: サポートされていない identity-provider-initiated login を使用しています。

対処: 直接リンク https://console.clickhouse.cloud/?connection={organizationid} を使用してください。これをユーザーの既定のログイン方法にするには、上記の アイデンティティプロバイダー の手順に従って設定してください。

アイデンティティプロバイダー に移動した後、ログインページに戻される

原因: アイデンティティプロバイダー でメール属性のマッピングが設定されていません。

対処: 上記の アイデンティティプロバイダー の手順に従ってユーザーのメール属性を設定し、再度ログインしてください。

ユーザーがこのアプリケーションに割り当てられていない

原因: そのユーザーが アイデンティティプロバイダー 内の ClickHouse アプリケーションに割り当てられていません。

対処: アイデンティティプロバイダー でそのユーザーをアプリケーションに割り当ててから、再度ログインしてください。

複数の SAML 組織がある場合でも、常に同じ組織に移動してしまう

原因: 最初の組織にまだログインしたままです。

対処: ログアウトしてから、別の組織にログインしてください。

URL に一時的に access denied と表示される

原因: メールドメインが設定済みのドメインと一致していません。

対処: このエラーの解決については、サポートにお問い合わせください。

よくある質問

ClickHouse Cloud は identity-provider-initiated サインインをサポートしていますか?

いいえ。サービスプロバイダー開始型 フローのみに対応しています。ユーザーは https://console.clickhouse.cloud にアクセスしてメールアドレスを入力し、アイデンティティプロバイダー にリダイレクトされます。ユーザーが URL を覚えなくて済むよう、ブックマークまたは直接リンク (https://console.clickhouse.cloud/?connection={organizationid}) を設定してください。

複数の組織で SAML SSO を使うにはどうすればよいですか?

ClickHouse Cloud は、組織ごとに個別の 接続 を設定することで、複数組織での SSO をサポートしています。

各組織への初回ログインでは、その直接リンク (https://console.clickhouse.cloud/?connection={organizationId}) を使用する必要があります。この初回ログインにより、その組織内にアカウントがプロビジョニングされます。組織で SCIM が有効になっている場合、アカウントはすでにプロビジョニングされているため、この手順は省略できます。

以降のサインインでは、任意の SAML 組織にログインしてください。他の SAML 組織はコンソールのサイドバーにある組織切り替えメニューで利用でき、いずれかを選択すると、その組織の SSO を通じてサインインします。

ユーザーが https://console.clickhouse.cloud でメールアドレスを入力した際に、該当ドメインのユーザーを自動的に組織へ振り分けないようにしたい場合は、その動作を無効にするようサポートチケットを起票してください。

同じユーザーに対して複数のアカウントが表示されるのはなぜですか?

ClickHouse Cloud では、SSO アカウントと非 SSO アカウントは自動的に関連付けられないため、両方の方法でサインインしたユーザーは、同じメールアドレスであってもユーザー一覧に複数回表示されることがあります。

次のステップ

Navigation