アカウント コネクタを構成する

このドキュメントでは、Developer Connect アカウント コネクタの詳細設定オプションを使用する方法について説明します。

アカウント コネクタは、Google Cloud アカウントを Google 以外のデベロッパー ツール プロバイダの個人アカウントに接続するのに役立つ Developer Connect の機能です。ユーザーは、アカウント コネクタがアクセスするデータの種類を指定できます。そのためには、そのコネクタに適切なスコープを選択します。組織のアカウント コネクタ接続が作成されると、その組織内のユーザーは、その接続を使用して、その接続で使用する個々のアカウントを承認できます。

Developer Connect の事前構成済み OAuth クライアント（GitHub や GitLab など）を使用するか、独自のカスタム OAuth クライアントを使用（オンプレミスの GitHub Enterprise インスタンスなど）して、アカウント コネクタを構成できます。

始める前に

  1. Google アカウントにログインします。

    Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

    8.

    Developer Connect を有効にすると、Secret Manager API も有効になります。

  8. 省略可: Developer Connect が作成する認証シークレットを暗号化するための顧客管理の暗号鍵（CMEK）を作成します。

必要なロール

アカウント コネクタの作成に必要な権限を取得するには、プロジェクトに対する Developer Connect OAuth 管理者 （roles/developerconnect.oauthAdmin）IAM ロールを付与するよう管理者に依頼します。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

使用可能なプロバイダを使用してアカウント コネクタを作成する

次の手順では、組み込みプロバイダのアカウント コネクタを作成する方法について説明します。アカウント コネクタを作成してカスタム OAuth クライアントを指定する場合は、カスタム OAuth クライアントを使用してアカウント コネクタを作成するをご覧ください。

Google Cloud コンソール

  1. Google Cloud コンソールで Developer Connect を開きます。

    Developer Connect に移動

  2. [アカウント コネクタ] を選択します。

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

  4. このアカウント コネクタを作成する [リージョン] を選択します。

  5. アカウント コネクタに名前を付けます。

  6. [構成タイプ] で [事前構成済みの OAuth クライアント] を選択します。

  7. OAuth プロバイダを選択します。

  8. Developer Connect プロキシを有効にするかどうかを選択します。

    プロキシが有効になっている場合、Developer Connect はユーザーに代わって Git コマンドを送信するか、プロバイダに HTTP 呼び出しを行います（またはその両方を行います）。詳細

  9. このアカウント コネクタの Developer Connect に付与するスコープを選択します。

    スコープは、選択したプロバイダのサービスで Developer Connect が実行できるアクションを決定します。スコープはプロバイダごとに異なります。プロバイダにスコープがない場合を除き、少なくとも 1 つのスコープを選択する必要があります。

    プロバイダによっては、選択できるスコープがない場合があります。手動で追加できる場合があります。スコープが必要になる場合もあります。

  10. [作成] をクリックして、このアカウント コネクタの作成を完了します。

Google Cloud CLI

アカウント コネクタを作成するには、次のコマンドを実行します。

   gcloud alpha developer-connect account-connectors create my-ac \
       --location=LOCATION \
       --provider-oauth-config-system-id=PROVIDER \
       --provider-oauth-config-scopes=SCOPES \
       --project=PROJECT_ID

このコマンドで、次のように置き換えます。

  • LOCATION は、このアカウント コネクタを作成するリージョンに置き換えます。

  • PROVIDER（接続先の SCM プロバイダ）:

    GITHUB、GITLAB、または BITBUCKET_CLOUD。

  • PROJECT_ID は、このアカウント コネクタを作成するプロジェクトのプロジェクト ID（プロジェクト番号ではない）に置き換えます。

カスタム OAuth クライアントを使用してアカウント コネクタを作成する

次の手順では、指定した OAuth クライアントを使用するようにアカウント コネクタを構成する方法について説明します。組み込みプロバイダを使用してアカウント コネクタを作成する場合は、使用可能なプロバイダを使用してアカウント コネクタを作成するをご覧ください。

Google Cloud コンソール

  1. Google Cloud コンソールで Developer Connect を開きます。

    Developer Connect に移動

  2. [アカウント コネクタ] を選択します。

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

  4. このアカウント コネクタを作成する [リージョン] を選択します。

  5. アカウント コネクタに名前を付けます。

  6. [構成タイプ] で [カスタム OAuth クライアント] を選択します。

    [アカウント コネクタの作成] 画面にリダイレクト URI が表示されます。

  7. リダイレクト URI をコピーします。

    URI の形式は次のようになります。

    https://developerconnect.google.com/redirect/custom/projects/<project_number>/locations/<location>/accountConnectors/<account_connector_id>

    この URI で、<project_number> はプロジェクト ID ではなく、プロジェクト番号です。

  8. コピーしたリダイレクト URI を使用して、選択した SCM 用のカスタムアプリを作成し、このフォームに戻って OAuth クライアントの詳細を指定します。

    1. プロバイダを選択します。

    2. [ホスト URI] フィールドに、ソースコード管理システムの URI を指定します。

    3. [Authorization URI] フィールドに、認証サーバーのアドレスを入力します。このアドレスの形式は次のとおりです。

      GitHub Enterprise の場合: https://<host_name>/login/oauth/authorize GitLab Enterprise の場合: https://<host_name>/oauth/authorize BitBucket データセンターの場合: https://<host_name>/rest/oauth2/latest/authorize

    4. [トークン URI] フィールドに、認証コードをアクセス トークンと交換するために使用する URI を指定します。このアドレスの形式は次のとおりです。

      GitHub Enterprise の場合: https://<host_name>/login/oauth/access_token GitLab Enterprise の場合: https://<host_name>/oauth/token BitBucket データセンターの場合: https://<host_name>/rest/oauth2/latest/token

    5. [クライアント ID] に、OAuth アプリのクライアント ID を入力します。

    6. クライアント シークレットを指定して、認証サーバーでアプリを認証します。

    7. アカウント コネクタが Git コマンドの発行に Developer Connect プロキシを使用する場合は、[Developer Connect プロキシを有効にする] を選択します。

    8. [スコープ] で、使用可能なスコープのリストから選択します。

    9. 必要に応じて、ネットワークとセキュリティを構成します。

      1. このアカウント コネクタで公共のインターネットを使用するか、プライベート ネットワークを使用するかを選択します。

        プライベート ネットワークの場合は、次の情報を提供します。

        • 使用する CA 証明書

        • Service Directory サービスの次の情報:

        Service Directory サービスのプロジェクトを特定するか、リージョン、Namespace、サービス名を指定できます。

      2. このアプリの PKCE を有効または無効にします。

        OAuth サービスで PKCE がサポートされている必要があります。

    10. [作成] をクリックして、このアカウント コネクタの作成を完了します。

Google Cloud CLI

  ```sh
  gcloud alpha developer-connect account-connectors create my-ac \
    --location=LOCATION \
    --project=PROJECT_ID \
    --custom-provider-oauth-config-system-id=PROVIDER \
    --custom-oauth-config-host-uri= HOST_URI \
    --custom-oauth-config-auth-uri=AUTH_URI \
    --custom-provider-oauth-config-scopes=SCOPES \
    --custom-oauth-config-token-uri=TOKEN_URI \
    --custom-oauth-config-client-id=CLIENT_ID \
    --custom-oauth-config-client-secret=SECRET

  ```

このコマンドで、次のように置き換えます。

  • LOCATION は、このアカウント コネクタを作成するリージョンに置き換えます。

  • PROJECT_ID は、このアカウント コネクタを作成するプロジェクトのプロジェクト ID（プロジェクト番号ではない）に置き換えます。

  • PROVIDER（接続先の SCM プロバイダ）:

    GITHUB_ENTERPRISE、GITLAB_ENTERPRISE、または BITBUCKET_DATA_CENTER。

  • HOST_URI は、ソースコード管理システムの URL に置き換えます。

  • AUTH_URI は、選択した SCM プロバイダへの認証に使用される URL に置き換えます。

    次に例を示します。

    • GitHub Enterprise: https://<host_name>/login/oauth/authorize

    • GitLab Self Hosted: https://<host_name>/oauth/authorize

    • BitBucket データセンター: https://<host_name>/rest/oauth2/latest/authorize

  • SCOPES は、このアカウント コネクタに含めるプロバイダの OAuth スコープのカンマ区切りのリストに置き換えます。

  • TOKEN_URI（認証コードをアクセス トークンと交換するために使用する URI）。

  • CLIENT_ID は、OAuth アプリのクライアント ID に置き換えます。

  • SECRET は、接続先の SCMS から提供されたシークレットに置き換えます。

アカウントの接続

アカウント コネクタを作成した後も、アカウント コネクタを使用するには、プロバイダを使用して Developer Connect をアカウントに接続する必要があります。

  1. Google Cloud コンソールで Developer Connect を開きます。

    Developer Connect に移動

  2. [アカウント コネクタ] を選択します。

    [アカウント コネクタ] ページには、プロジェクト内のすべてのアカウント コネクタが一覧表示されます。

  3. プロバイダ アカウントを接続するアカウント コネクタの名前をクリックします。

    [コネクタの詳細] ページが表示されます。

  4. [アカウントを接続] をクリックします。

    OAuth 認証ダイアログが表示されます。

  5. ダイアログに情報を入力して、プロバイダに対する認証を行います。

  6. [承認] をクリックします。

アカウント コネクタを更新する

既存のアカウント コネクタを更新できますが、更新できるのは、そのコネクタのスコープ、プロキシ設定のオン / オフの切り替え、またはその両方のみです。特定のアカウント コネクタのスコープを更新すると、そのコネクタの既存のユーザーはすべて削除されます。

  1. Google Cloud コンソールで Developer Connect を開きます。

    Developer Connect に移動

    Developer Connect に [Git リポジトリ] ページが表示されます。

  2. [アカウント コネクタ] を選択します。

    [アカウント コネクタ] ページには、プロジェクト内のすべてのアカウント コネクタが一覧表示されます。

  3. 更新するアカウント コネクタの名前をクリックします。

    [コネクタの詳細] ページが表示されます。

  4. [編集] をクリックします。

  5. [スコープ] リストから、このアカウント コネクタで許可するスコープを選択します。

  6. [保存] をクリックします。

アカウント コネクタを削除する

  1. Google Cloud コンソールで Developer Connect を開きます。

    Developer Connect に移動

    Developer Connect に [Git リポジトリ] ページが表示されます。

  2. [アカウント コネクタ] を選択します。

    [アカウント コネクタ] ページには、プロジェクト内のすべてのアカウント コネクタが一覧表示されます。

  3. [その他] メニューから [削除] を選択します。

    [コネクタの詳細] ページが表示されます。

  4. [編集] をクリックします。

次のステップ