Confluence Cloud の構成

このページでは、Confluence Cloud データストアを作成する前に Confluence Cloud インスタンスを設定する方法について説明します。

認証と権限を設定する

Atlassian 管理者アカウント センターで認証と権限を設定する必要があります。これは、コネクタがデータにアクセスして同期できるようにするために不可欠です。Confluence Cloud コネクタは、OAuth クライアント認証情報や API トークンなど、さまざまな認証方法をサポートしています。

OAuth 2.0 アプリを作成する

認証用の OAuth 2.0 アプリを作成するには、次の手順に沿って Atlassian Developer Console でアプリケーションを設定し、必要なクライアント ID とクライアント シークレットを取得します。

Confluence 組織管理者のアクセス権を確認する

Confluence 組織管理者のアクセス権を確認するには、次の操作を行います。

  1. ユーザー認証情報を使用して Atlassian にログインします。

  2. [Confluence] アプリを選択します。

  3. [設定] をクリックします。

    [Confluence settings] に [System] オプションが表示されている場合は、Confluence 組織管理者のアクセス権があります。それ以外の場合は、Confluence 組織管理者にアクセス権の付与をリクエストしてください。

OAuth 2.0 アプリを作成する

OAuth 2.0 アプリを作成するには、次の操作を行います。

  1. Atlassian Developer Console にログインします。

  2. プロフィール アイコンをクリックし、[Developer console] を選択します。

  3. [Console] ページで、[Create] をクリックし、[OAuth 2.0 Integration] を選択します。

  4. アプリの作成ページで、次の操作を行います。

    1. アプリの名前を入力します。

    2. チェックボックスをオンにして、Atlassian のデベロッパー利用規約に同意します。

    3. [作成] をクリックします。

  5. アプリのページで、次の操作を行います。

    1. ナビゲーション メニューで [承認] をクリックします。

    2. [Authorization type] テーブルで、[OAuth 2.0（3LO）] の [Add] を選択します。

  6. [コールバック URL] フィールドに「https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html」と入力します。

  7. [変更を保存] をクリックします。

クライアント ID とクライアント シークレットを取得する

クライアント ID とクライアント シークレットを取得するには、次の操作を行います。

  1. アプリのページで、ナビゲーション メニューから [配布] をクリックします。

  2. [配布] ページで、次の操作を行います。

    1. [配信の制御] セクションで、[編集] を選択します。
    2. [配信ステータス] セクションで、[共有] を選択して、他のフィールドの編集を有効にします。
    3. 次の必須項目に情報を入力します。
      1. [Vendor] に「Google」と入力します。
      2. [Privacy policy] に「https://policies.google.com」と入力します。
      3. [Does your app store personal data?] で、[Yes] を選択します。
      4. [I confirm that I've implemented the personal data reporting API] チェックボックスをオンにします。
    4. [変更を保存] をクリックします。

  3. アプリのページで、次の操作を行います。

    1. ナビゲーション メニューで [設定] をクリックします。
    2. 設定ページで、クライアント ID とクライアント シークレットをコピーします。

インスタンス ID とインスタンス URL を取得する

  1. 次の手順でインスタンス ID を取得します。

    1. 新しいタブを開き、インスタンスの URL をコピーして、インスタンスの URL に /_edge/tenant_info を追加します。例: https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info
    2. リンクに移動して cloudId の値を見つけます。cloudId がインスタンス ID です。

  2. 次の手順でインスタンスの URL を取得します。

    1. atlassian.net に移動し、管理者アカウントでログインします。
    2. 同期するアプリを選択します。たとえば、最初のアプリを同期します。
    3. インスタンスの URL（アドレスバーのサブドメイン）を確認します。

管理者ロールを付与

Google Cloud コンソールで Confluence 管理者にディスカバリー エンジン編集者のロールを付与するには、次の操作を行います。

  1. Google Cloud コンソールで、[Gemini Enterprise] ページに移動します。

  2. IAM に移動します。

    IAM に移動

  3. Confluence で管理者のアクセス権を持つユーザー アカウントを見つけて、編集アイコン をクリックします。

  4. 管理者にディスカバリー エンジン編集者のロールを付与します。

Atlassian でユーザーに管理者ロールを付与するには、次の操作を行います。

  1. 組織管理者アカウントを使用して Atlassian にログインします。

  2. メニュー アイコンをクリックして、組織を選択します。または、admin.atlassian.com に移動します。

  3. [管理] ページでプロダクトをクリックし、[ユーザーを管理] ボタンを選択します。

  4. [ユーザー管理] で [グループ] をクリックします。

  5. [Groups] ページで、次の操作を行います。

    1. [Create group] をクリックします。
    2. グループの名前を入力します。

このグループに、コネクタに必要な権限が付与されます。このグループに追加されたユーザーは、これらの権限を継承します。コネクタはこのグループを使用して認証を行い、ドキュメントを取得します。

  1. [Group] ページで、[Add product] をクリックします。

  2. Confluence のロールとして [User access admin] を選択します。

  3. Confluence 管理のロールとして [Product admin] を選択します。

  4. [アクセス権を付与] をクリックします。

  5. [Add group members] をクリックして、コネクタが認証と必要なリソースへのアクセスに使用するユーザー アカウントまたはグループ メンバーを追加します。

最小アプリケーション スコープを構成する

OAuth 2.0 を構成し、Confluence コネクタの設定に必要な認証情報を取得するには、次の操作を行います。

  1. OAuth 2.0 を有効にします。
    1. [権限] をクリックします。
    2. [Confluence API] に移動します。
    3. [Add] をクリックします。
    4. [Configure] をクリックします。
    5. [詳細なスコープ] タブに移動し、[スコープを編集] をクリックします。
    6. 次のスコープを選択します。
      • read:attachment:confluence
      • read:configuration:confluence
      • read:content.metadata:confluence
      • read:content-details:confluence
      • read:whiteboard:confluence
      • read:group:confluence
      • read:space:confluence
      • read:user:confluence
      • search:confluence
      • write:page:confluence
      • write:attachment:confluence
    7. すべてのスコープが選択されていることを確認し、変更を保存します。

Confluence で API トークンを設定する

認証に API トークンを使用する場合は、スコープなしの API トークンを作成する必要があります。このコネクタは、スコープ付きの API トークンをサポートしていません。

  1. Atlassian Console にログインします。
  2. [Create API Token] をクリックします。
  3. API トークンの名前を入力します。
  4. API トークンの有効期限を選択します。トークンの有効期限は 1～365 日です。
  5. [Create] をクリックします。
  6. 後で使用するためにトークンを保存します。

ユーザーの可視性を管理する

ユーザーのメールアドレスを Atlassian アカウントのすべてのユーザーに表示する手順は次のとおりです。

  1. Atlassian Developer Console にログインします。

  2. プロフィール アイコンをクリックし、[Developer console] を選択します。

  3. ユーザー プロフィール アイコンをクリックし、[Manage account] を選択します。

  4. [Profile and visibility] に移動します。

  5. [Contact] に移動し、[Who can see this] を [Anyone] に設定します。

ユーザーのメールアドレスを Confluence のすべてのユーザーに表示するには、次の操作を行います。

  1. ユーザー認証情報を使用して Atlassian にログインします。

  2. Confluence アプリを選択します。

  3. [Settings] > [System] をクリックします。

  4. 左側のペインで [General Configuration] を選択します。

  5. [Edit Settings] をクリックします。

  6. [ユーザーのメールの公開設定] で、[公開] を選択します。

  7. [更新] をクリックします。

User Identity Accessor for Confluence Cloud をインストールして構成する

Confluence Cloud のプライバシー設定により、ユーザーのメールアドレスがデフォルトで一般公開されていない場合は、User Identity Accessor for Confluence Cloud アプリをインストールして、ユーザーのメールアドレスを安全に取得する必要があります。ユーザーのメールアドレスがすでに一般公開されている場合は、アプリをインストールする必要がないことがあります。メールアドレスの公開制限について詳しくは、ユーザーの可視性を管理してロールを付与するをご覧ください。

ロールと権限

User Identity Accessor for Confluence Cloud アプリをインストールして構成するには、適切な管理者ロールが割り当てられており、必要なアプリレベルの権限を付与する必要があります。

  • 必要なロール: アプリをインストールして構成するには、Confluence Site administrator である必要があります。
  • アプリレベルの権限: アプリのインストール時に次の権限を付与する必要があります。
    • Read Email Address: プロフィールの公開設定が制限されている場合でも、アプリがユーザーのメールアドレスを安全に取得できるようにします。
    • App Storage scope: アプリがストレージ デバイスへの読み取りと書き込みを行えるようにします。

User Identity Accessor for Confluence Cloud をインストールする

Confluence サイトに User Identity Accessor for Confluence Cloud アプリをインストールする手順は次のとおりです。

  1. Atlassian Developer Console に移動します。

  2. [メールアドレスの読み取り] と [アプリ ストレージのスコープ] の権限を確認し、[アプリを入手] をクリックします。

  3. [Select a site to install this app on] リストから、アプリをインストールする Confluence サイトを選択します。このリストには、管理者権限を持つサイトのみが表示されます。

    注: アプリをインストールするには、少なくとも 1 つの Confluence サイトの管理者である必要があります。

  4. [Install] をクリックして、アプリのインストールを完了します。

User Identity Accessor for Confluence Cloud を構成する

User Identity Accessor for Confluence Cloud アプリをインストールしたら、外部システム（Confluence Cloud コネクタなど）がアプリのウェブトリガーを安全に呼び出してメールアドレスを取得するために使用する API キーを構成します。

構成ページにアクセスする

Confluence Cloud で User Identity Accessor for Confluence Cloud アプリの構成ページにアクセスする手順は次のとおりです。

  1. Confluence Cloud インスタンスで、ナビゲーション メニューの設定アイコン ⚙️ をクリックします。
  2. メニューから [Apps] を選択します。
  3. [Apps administration] ページで、[Manage apps] リストからアプリ [User Identity Accessor for Confluence Cloud] を見つけます。
  4. [構成] をクリックするか、アプリに関連付けられているリンクをクリックします。Confluence 内にアプリ専用の構成ページが開きます。

API キーを設定する

構成ページで API キーを設定する手順は次のとおりです。

  1. [API Key Configuration] セクションで、アプリのウェブトリガーへのリクエストを認証するためのシークレット キーを指定します。リクエストの認証には、次のいずれかの方法を使用できます。

    • 独自のキーを入力: 独自の強力な一意の API キーを [API Key] フィールドに入力するか貼り付けます。大文字、小文字、数字、記号を組み合わせた 20～30 文字以上のキーを使用します。

    • キーを生成する: [新しいキーを生成] ボタンをクリックします。システムによって、強力なランダムキーが生成され、フィールドに表示されます。

      重要: フィールドに表示された API キーをすぐにコピーしてください。セキュリティ上の理由から、保存後や移動後に完全なキーを再度表示できない場合があります。紛失した場合は、新しいキーを設定または生成する必要があります。

  2. [Save API Key] をクリックします。成功メッセージが表示され、キーが安全に保存されたことを確認できます。

アプリの構成をテストする

User Identity Accessor for Confluence Cloud アプリが正しく構成されていることを検証するために、外部システムからリクエストを送信して、ユーザーのメールアドレスが正常に返されることを確認します。

ウェブトリガー URL を取得する
  1. [Apps administration] ページで、[Webtrigger URL] セクションを見つけます。このセクションには、Confluence サイトとこのアプリのインストールに固有の URL が表示されます。
    • 外部システムは、この URL を呼び出してユーザーのメールアドレスをリクエストする必要があります。たとえば、https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID の場合、YOUR_INSTANCE_ID は Confluence Cloud インスタンスの識別子、WEBTRIGGER_ID はアプリ用に生成されたウェブトリガー エンドポイントの固有識別子です。
  2. [Copy URL] ボタンをクリックするか、URL 全体をコピーします。
外部システムを構成する

  • 前の手順で取得した API キーとウェブトリガー URL を使用して、Confluence ユーザーのメールアドレスを取得する必要がある外部システムを構成します。

    • エンドポイント URL: コピーしたウェブトリガー URL。
    • HTTP メソッド: POST

    • 必須ヘッダー:

      • Content-Type: application/json

      • X-Api-Key: YOUR_API_KEY

        YOUR_API_KEY は、API キーを設定するセクションで設定または生成した API キーに置き替えます。

curl コマンドの例

この例では、アカウント ID の配列を受け取り、メールアドレスを返す User Identity Accessor for Confluence Cloud ウェブトリガーを呼び出す方法を示します。

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

次のように置き換えます。

  • YOUR_INSTANCE_ID は、Confluence Cloud インスタンス ID に置き換え
  • ENDPOINT_PATH: API エンドポイント パス
  • YOUR_API_KEY: API キーを設定するセクションで設定または生成した API キー
  • ACCOUNT_ID: ターゲットにする Atlassian アカウント ID
想定されるレスポンス
[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

次のように置き換えます。

  • ACCOUNT_ID_X: 実際の Atlassian アカウント ID
  • USER_EMAIL_X: API 呼び出しから返されたユーザーのメールアドレス

セキュリティのベスト プラクティスを実装する

API キーの安全性を確認するには、次の推奨事項に従ってください。

  • API キーを Confluence Cloud コネクタの構成内に安全に保存します。
  • Webhook URL とのすべての通信が HTTPS 経由で行われることを確認します。これは、User Identity Accessor for Confluence Cloud ウェブトリガーのデフォルトです。

User Identity Accessor for Confluence Cloud のサポート

Google では、User Identity Accessor for Confluence Cloud アプリのサポートを提供しています。このサポートには、アプリを最新の状態に保つためのメンテナンスや定期的な更新が含まれます。問題が発生した場合や、アプリの機能についてご不明な点がある場合は、Google Cloud サポートにお問い合わせください。