Secret Manager API を有効にする

Secret Manager は、REST API と gRPC API を公開し、直接またはアプリケーション内でシークレットを使用、管理します。このページでは、Secret Manager API を有効にし、Secret Manager を初めて使用するように Google Cloud プロジェクトを構成する方法について説明します。

Secret Manager に慣れたら、個別の Google Cloud プロジェクトを使用することをおすすめします。プロジェクトを削除すると、テスト中に作成されるすべてのリソース(課金対象のリソースを含む)も削除されます。

Cloud Code がインストールされている IDE でアプリケーションを開発している場合、Secret Manager は拡張機能に統合されています。つまり、IDE を終了せずに、シークレットを作成、表示、更新、使用できます。Cloud Code で Secret Manager を使用する方法の詳細については、任意の IDE、VS CodeIntelliJ、または Cloud Shell エディタのシークレット管理ガイドを参照してください。

始める前に

  1. In the Google Cloud console, go to the project selector page.

    Go to project selector

  2. Select or create a Google Cloud project.

Secret Manager API を有効にする

Console

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

    Secret Manager API に移動する

  2. ページの上部にあるプロジェクト セレクタにプロジェクト名が表示されていることを確認します。

    プロジェクトの名前が表示されない場合は、プロジェクト セレクタをクリックしてプロジェクトを選択します。

  3. [有効にする] をクリックします。

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. gcloud セッションで Google Cloud プロジェクトを設定するには、gcloud config set project コマンドを実行します。PROJECT_ID は、実際の Google Cloud プロジェクト ID に置き換えます。
    gcloud config set project PROJECT_ID
  3. Secret Manager API を有効にするには、gcloud services enable コマンドを実行します。
    gcloud services enable secretmanager.googleapis.com
  4. Secret Manager API が有効になっていることを確認するには、gcloud services list コマンドを実行します。
    gcloud services list --enabled

    Secret Manager API が有効な API のリストに含まれていることを確認します。

リージョン エンドポイントを使用するように Secret Manager を構成する

リージョン シークレットを作成するには、リージョン エンドポイントを使用するように Secret Manager を構成する必要があります。リージョン エンドポイントは、影響を受けるリソースがエンドポイントで指定されたロケーションに存在する場合にのみ、リクエストの続行を許可するリクエスト エンドポイントです。リージョン エンドポイントを使用すると、データ所在地とデータ主権の要件を遵守する方法でワークロードを実行できます。

リージョン エンドポイントの形式は次のとおりです。

SERVICE_NAME.LOCATION.rep.googleapis.com

リージョン エンドポイントを使用するには、Secret Manager サービスへのアクセス方法に応じて、リージョン エンドポイントのアドレスで構成を更新する必要があります。

gcloud

リージョン エンドポイントを使用するように Google Cloud CLI を構成するには、次の操作を行います。

  1. Google Cloud CLI 402.0.0 以降を使用していることを確認します。

  2. api_endpoint_overrides/secretmanager プロパティを、使用するリージョン エンドポイントに設定します。

    gcloud config set api_endpoint_overrides/secretmanager https://secretmanager.LOCATION.rep.googleapis.com/

    LOCATION は、サポートされている Google Cloud ロケーションの名前(me-central2 など)に置き換えます。

REST

API を使用して Secret Manager サービスに接続するには、汎用 API エンドポイント URL(https://secretmanager.googleapis.com/v1/)を、使用する特定のリージョン エンドポイントに置き換えます。リージョン エンドポイントは次の形式を使用します。

https://secretmanager.LOCATION.rep.googleapis.com/v1/

LOCATION は、サポートされている Google Cloud ロケーションの名前(me-central2 など)に置き換えます。

サポートされているロケーションを確認するには、Secret Manager のロケーションをご覧ください。

ロールと権限を構成する

Secret Manager の設定に必要な権限を取得するには、プロジェクトに対する Secret Manager 管理者 roles/secretmanager.admin)IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

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

Secret Manager のアクセス制御の詳細については、IAM によるアクセス制御をご覧ください。

次のステップ