始める前に
- ClickHouse Cloud 組織の Admin ロール。
- Entra ID と ClickHouse Cloud の間で SAML SSO がすでに設定されていること。SCIM でユーザーアカウントが作成され、それらのアカウントは SAML 経由でサインインするため、事前に SSO が機能している必要があります。
- エンタープライズアプリケーションの Provisioning を設定する権限を持つ、少なくとも Application Administrator (または Cloud Application Administrator) ロールが割り当てられた Microsoft Entra 管理センターへのアクセス。
- SCIM 経由で割り当てるロールのリスト (例: Admins、Developers、Read-only) 。事前に決定してください。Entra ID で対応するグループを作成します。
SCIM と ClickHouse Cloud の連携の仕組み
- Entra ID の管理者が、ユーザーを直接、またはグループを介して ClickHouse Cloud のエンタープライズアプリケーションに割り当てます。
- Entra ID のプロビジョニングサービスが、生成した Bearer token を使用して認証を行い、HTTPS 経由で ClickHouse Cloud の SCIM エンドポイント を呼び出します。
- ClickHouse Cloud は組織内にユーザーを作成し、Entra ID のグループメンバーシップに基づいてロールを割り当てます。
- ユーザーは、既存の SAML SSO フローを介して ClickHouse Cloud にサインインします。
- Entra ID でのプロファイル、グループの変更、およびアカウントの無効化は、ClickHouse Cloud に自動的に反映されます。
ClickHouse Cloud 組織で SCIM を設定する
1
SCIM を有効にする
組織の管理者として ClickHouse Cloud Console にサインインし、組織設定 → SAML and SCIM settings → SCIM Configuration を開きます。コピーしておきます。後で Entra ID の Tenant URL として貼り付けます。
Enable SCIM をクリックします。SAML SSO を接続すると SCIM のロックが解除されます。オプションがグレーアウトされている場合は、先に SAML の設定を完了してください。次の形式の SCIM endpoint URL が生成されます。2
SCIM アクセストークンを生成する
Generate new key セクションで、有効期限を選択します。Generate new key をクリックします。トークンは、キー (scim_ で始まる) とシークレットとして 一度だけ 表示されます。すぐに両方をコピーし、安全なシークレットマネージャーに保存してください。後から取得することはできません。紛失した場合は、トークンを取り消して新しいトークンを生成してください。Entra ID 用に、キーとシークレットを次の形式の単一の Bearer token に結合します。scim_ で始まるトークンのキー、コロン、トークンのシークレットを、スペースを入れずに連結します。Entra ID は、すべてのリクエストでこの値を Authorization: Bearer ヘッダーとして送信します。3
ロールマッピングを定義する
SCIM Configuration パネルで Map roles in “Users and roles” をクリックします (または Users and roles → Roles から直接移動します) 。SCIM グループは名前に基づいて ClickHouse Cloud ロールに紐付けられます。以下のルールに注意してください。
- SCIM グループを定義済みのシステムロールにマッピングすることはできません。 SCIM マッピングはカスタムロールにのみ適用されます。SCIM を通じてシステムレベルの機能を公開する必要がある場合は、必要な権限をまとめたカスタムロールを作成してください。
- 名前が一致すると自動的に紐付けられます。 カスタムロールが受信した SCIM グループと同じ名前の場合、ClickHouse Cloud は自動的に紐付けます。手動でマッピングする必要はありません。
- グループ名とは異なるロール名を使用するには、使用するロール名でカスタムロールを作成し、その SCIM group フィールドを紐付ける SCIM グループの名前に設定します。
- マッピングされていないグループでは新しいロールが作成されます。 Entra ID が、既存のロール名と一致せず、どのロールの
SCIM groupフィールドからも参照されていないグループをプッシュすると、ClickHouse Cloud はそのグループ名で新しいカスタムロールを作成します。その後、必要な権限を付与できます。
Microsoft Entra ID でプロビジョニングを設定する
1
ClickHouse Cloud Enterprise アプリケーションを開きます
Microsoft Entra ID の概要を開き、左側のメニューの Manage で Enterprise applications を選択します。ClickHouse Cloud の SAML SSO を設定した際に作成したアプリケーションを開きます。エンタープライズ アプリケーションをまだ作成していない場合は、まず SAML SSO セットアップガイド に従ってください。SAML ベースの SSO では、同じエンタープライズ アプリケーションをシングルサインオンと SCIM プロビジョニングの両方に使用します。
2
プロビジョニング モードと認証情報を設定する
アプリケーションの左側のサイドバーで、Provisioning を選択し、
Get started (または Provisioning → Edit provisioning) をクリックします。Provisioning Mode を Automatic に設定します。Admin Credentials で、以下の項目を入力します。- Tenant URL — ClickHouse Cloud Console の SCIM エンドポイント URL (
.../scimURL) 。 - Secret Token — SCIM 認証情報をコロンで連結したもの。形式は
<scim-key>:<scim-secret>です。Entra ID はこれをAuthorization: Bearerヘッダーとして送信します。
Test Connection をクリックします。Entra ID が SCIM エンドポイントに対してテスト呼び出しを行い、成功通知が表示されます。失敗した場合は、トラブルシューティングを参照してください。Save をクリックします。3
属性マッピングを設定する
認証情報を保存したら、Mappings セクションを展開します。Entra ID には次の 2 つのマッピングセットが表示されます。
- Provision Microsoft Entra ID Users
- Provision Microsoft Entra ID Groups
userPrincipalName を userName にマッピングします。重要なのは、userName の値の取得元が、ユーザーが SAML SSO でサインインする際に使用するメールアドレスと同じメールアドレスを持つ属性であることです。特定の属性名である必要はありません。一部のテナントでは userPrincipalName がすでにそのメールアドレスであるため、変更は不要です。一方、メールアドレスが mail に格納されている場合は、mail を userName の取得元にするようマッピングを編集します。取得元を変更するには、userName の行をクリックし、Source attribute を正しい属性に設定して保存します。userName がプライマリの照合属性となるよう、Matching precedence を設定します。サポートされていないマッピングは削除できます。SCIM の標準セット以外の項目は ClickHouse Cloud 側で無視されます。以下の行はデフォルトでマッピングされています。各項目が正しく設定されていることを確認してください。Provision Microsoft Entra ID Groups を開き、
displayName が displayName に、members が members にマッピングされていることを確認します。グループの表示名は、ClickHouse Cloud のロールへのバインドに使用されます。4
Provisioning の適用範囲を設定する
Settings セクションを展開します。
- Scope を
Sync only assigned users and groupsに設定します。これにより、プロビジョニングの対象が、次のステップでアプリケーションに明示的に割り当てるユーザーとグループに限定されます。 - Provisioning Status は、テストユーザーを割り当てた後にオンにするため、現時点では
Offのままにします。
Save をクリックします。5
グループとユーザーの割り当て
ここでロールが自動的に適用されます。Entra ID でグループを作成します。 先ほど設定した各ロールマッピングについて、表示名が完全に同じ Entra ID グループを作成または特定します。たとえば、マッピングが ユーザーを割り当てます。 次の 2 つの方法があります。
ClickHouse-Admins → Admin の場合は、Entra ID で ClickHouse-Admins というグループを作成します。グループをアプリケーションに割り当てます。 エンタープライズ アプリケーションで、Users and groups → Add user/group に移動し、ロールグループを選択して割り当てます。各ロールグループについて繰り返します。アプリケーションのプロビジョニング スコープは assigned users and groups に設定されているため、プロビジョニングされるのはこれらのグループとそのメンバーのみです。グループのプロビジョニングには適切な Entra ID ライセンスが必要ですメンバーだけでなくグループ自体をプロビジョニングするには、Microsoft Entra ID P1 以上が必要です。グループのプロビジョニングでは、グループ自体が ClickHouse Cloud に作成され、表示名に基づいて対応するロールに関連付けられます。
- グループ経由 (推奨) 。 アプリケーションに割り当てた Entra ID グループにユーザーを追加します。ユーザーは ClickHouse Cloud にプロビジョニングされ、対応するロールが自動的に割り当てられます。
- 直接割り当て。 Users and groups で個々のユーザーをアプリケーションに割り当てます。割り当て済みグループのメンバーでもある場合を除き、ユーザーは Default role でプロビジョニングされます。
6
プロビジョニングを有効にする
Provisioning に戻り、Provisioning Status を
On に設定して、Save をクリックします。Entra ID は定期的に (約 40 分ごと) プロビジョニングを実行します。テストなどで特定のユーザーをすぐにプロビジョニングするには、Provisioning → Provision on demand でユーザーを検索し、プロビジョニングを 1 回実行します。インテグレーションをテストする
いずれかの手順に失敗した場合は、続行する前に根本原因を解決してください。通常、問題は連鎖的に悪化します。
本番環境のベストプラクティス
トークンを定期的にローテーションする
直接割り当てではなくグループを使用する
監査ログを確認する
適切なデフォルトロールを設定する
SCIM と手動招待を併用しない
Provisioning サイクルを考慮する
トラブルシューティング
Entra ID で「Test connection」が失敗する
Entra ID で「Test connection」が失敗する
- ClickHouse Cloud Console で SCIM が有効になっていることを確認します。
- Entra ID の Tenant URL が Cloud Console に表示されている SCIM エンドポイント URL と完全に一致していることを確認します。組織 ID が正しく設定されている必要があります。
- Secret Token が
<scim-key>:<scim-secret>の形式であることを確認します。scim_で始まるキー、コロン、シークレットの順に指定します。先頭または末尾に空白を含めず、Bearerプレフィックスも付けないでください (Entra ID により自動的に追加されます) 。 - トークンをローテーションした場合は、以前のペアではなく、新しいキーとシークレットを使用していることを確認します。
ユーザーは作成されるが権限がない
ユーザーは作成されるが権限がない
- 想定するロールについて、Map roles in “Users and roles” に行を追加していることを確認します。
- Entra ID のグループ名が、マッピング内の SCIM グループ名と、大文字・小文字やハイフンも含めて完全に一致していることを確認します。
- 意図的に一部のユーザーをグループなしでプロビジョニングする場合は、Default role が設定されていることを確認します。
ユーザーまたはグループがまったくプロビジョニングされない
ユーザーまたはグループがまったくプロビジョニングされない
- Provisioning Status が
Onになっていることを確認します。 - Scope が
Sync only assigned users and groupsに設定され、ユーザーまたはグループが Users and groups で実際にアプリケーションに割り当てられていることを確認します。 - プロビジョニングサイクルは約40分ごとに実行されます。個別のユーザーをすぐにテストするには、Provision on demand を使用します。
- メンバーだけでなくグループ自体をプロビジョニングするには、Microsoft Entra ID P1 以上が必要です。
メンバーリストに重複したユーザーが表示される
メンバーリストに重複したユーザーが表示される
通常、Entra ID と以前の手動招待でメールアドレスの大文字・小文字が一致していないことが原因です。Members リストから重複したユーザーを削除し、Entra ID でそのユーザーの割り当てを解除してから再度割り当てます (または Provision on demand を再実行します) 。
グループのプロビジョニングが名前の不一致で失敗する
グループのプロビジョニングが名前の不一致で失敗する
Entra ID のグループ表示名が、ClickHouse Cloud で設定されているマッピングと一致していません。Entra ID グループの名前を変更するか、SCIM Configuration パネルの Map roles in “Users and roles” でマッピングを追加します (または Users and roles → Roles から追加します) 。
無効化されたユーザーがメンバーとして表示され続ける
無効化されたユーザーがメンバーとして表示され続ける
無効化は次のプロビジョニングサイクルで反映されます。すぐに反映させるには、そのユーザーに対して Provision on demand を使用します。その後もユーザーがメンバーとして残っている場合は、Provisioning → View provisioning logs で無効化操作に関するエラーを確認します。
SCIM トークンをローテーションした後、Entra ID が失敗するようになった
SCIM トークンをローテーションした後、Entra ID が失敗するようになった
Entra ID の正しいエンタープライズアプリケーションで、
<scim-key>:<scim-secret> 形式の Secret Token を更新したことを確認します。更新後、Test Connection をクリックして確認します。プロビジョニングが正常な状態に戻ったら、ClickHouse Cloud Console で古いトークンを取り消します。SCIM トークンを紛失した
SCIM トークンを紛失した
トークンは復元できません。ClickHouse Cloud Console の 組織設定 → SAML and SCIM settings → SCIM Configuration で、紛失したトークンを取り消して新しいトークンを生成し、Entra ID の Secret Token を更新します。
よくある質問
SCIM を使用するには、事前に SAML SSO が必要ですか?
SCIM を使用するには、事前に SAML SSO が必要ですか?
はい。SCIM はユーザーアカウントを作成しますが、ClickHouse Cloud では SAML を使用して認証されます。まず SAML SSO を設定してください。
SAML と SCIM に同じエンタープライズアプリケーションを使用できますか?
SAML と SCIM に同じエンタープライズアプリケーションを使用できますか?
はい。SAML ベースの SSO では、1 つの Entra ID エンタープライズアプリケーションでシングルサインオンと SCIM プロビジョニングの両方を処理できます。
Secret Token が key:secret 形式なのはなぜですか?
Secret Token が key:secret 形式なのはなぜですか?
Entra ID は、Secret Token を
Authorization: Bearer ヘッダーとして送信して認証します。ClickHouse Cloud の SCIM エンドポイントでは、ベアラー値として、トークンキーとシークレットをコロンで連結した値を想定しています。Entra ID での変更はどのくらいで ClickHouse Cloud に反映されますか?
Entra ID での変更はどのくらいで ClickHouse Cloud に反映されますか?
Entra ID は約 40 分ごとのサイクルでプロビジョニングを実行します。すぐに更新するには、対象ユーザーに対して Provision on demand を使用してください。
困った場合はどこでサポートを受けられますか?
困った場合はどこでサポートを受けられますか?
ClickHouse Cloud Console の Help → Contact support からサポートチケットを作成し、次の情報を含めてください。
- 組織 ID
- Entra ID エンタープライズアプリケーションの名前 (およびオブジェクト ID)
- Provisioning → View provisioning logs にある失敗したエントリのスクリーンショット