サービスアカウントとして認証する

このトピックでは、アプリケーションをサービスアカウントとして認証する方法について説明します。一般的な認証シナリオや方法など、Google Cloud APIs への認証に関する一般的な情報については、認証の概要をご覧ください。サービスアカウントの詳細については、Identity and Access Management のドキュメントでサービスアカウントをご覧ください。

注: アプリケーションがオンプレミスまたは別のクラウドプロバイダで実行されている場合、Workload Identity 連携を使用することで、サービスアカウントキーを使用せずに外部 ID へのアクセス権を付与できます。一部のクライアントライブラリでは、アプリケーションのデフォルト認証情報（ADC）を使用して外部 ID の認証情報を自動的に生成できます。

詳細については、ご利用の ID プロバイダのドキュメントをご覧ください。

認証情報の自動検出

アプリケーションが Google Cloud 環境内で実行され、その環境にサービスアカウントを接続すると、アプリケーションはサービスアカウントの認証情報を取得できます。その後、アプリケーションはその認証情報を使用して、Google Cloud APIs を呼び出すことができます。

サービスアカウントは、Compute Engine、Google Kubernetes Engine、App Engine、Cloud Run、Cloud Functions など、さまざまな Google Cloud サービスのリソースに接続できます。これは、認証情報を手動で提供するよりも便利で安全なため、この方法をおすすめします。

また、アプリケーションには Google Cloud クライアントライブラリを使用することをおすすめします。Google Cloud クライアントライブラリでは、アプリケーションのデフォルト認証情報（ADC）というライブラリを使用して、サービスアカウントの認証情報を自動的に検索します。サービスアカウントの認証情報は次の順序で検索されます。

環境変数 GOOGLE_APPLICATION_CREDENTIALS が設定されている場合、ADC では、変数が示すサービスアカウントキーまたは構成ファイルを使用します。
環境変数 GOOGLE_APPLICATION_CREDENTIALS が設定されていない場合、ADC はコードを実行しているリソースに関連付けられているサービスアカウントを使用します。

このサービスアカウントは、Compute Engine、Google Kubernetes Engine、App Engine、Cloud Run、Cloud Functions によって提供されるデフォルトのサービスアカウントである場合があります。作成したユーザー管理のサービスアカウントである可能性もあります。
ADC が上に示したいずれの認証情報も使用できない場合は、エラーが発生します。

次のサンプルコードは、アプリケーションコードで ADC ライブラリを使用する方法を示しています。このサンプルを実行するには、Cloud Storage クライアントライブラリをインストールする必要があります。

C#

GitHub で表示

public object AuthImplicit(string projectId)
{
    // If you don't specify credentials when constructing the client, the
    // client library will look for credentials in the environment.
    var credential = GoogleCredential.GetApplicationDefault();
    var storage = StorageClient.Create(credential);
    // Make an authenticated API request.
    var buckets = storage.ListBuckets(projectId);
    foreach (var bucket in buckets)
    {
        Console.WriteLine(bucket.Name);
    }
    return null;
}

Go

GitHub で表示


// implicit uses Application Default Credentials to authenticate.
func implicit() {
	ctx := context.Background()

	// For API packages whose import path is starting with "cloud.google.com/go",
	// such as cloud.google.com/go/storage in this case, if there are no credentials
	// provided, the client library will look for credentials in the environment.
	storageClient, err := storage.NewClient(ctx)
	if err != nil {
		log.Fatal(err)
	}

	it := storageClient.Buckets(ctx, "project-id")
	for {
		bucketAttrs, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			log.Fatal(err)
		}
		fmt.Println(bucketAttrs.Name)
	}

	// For packages whose import path is starting with "google.golang.org/api",
	// such as google.golang.org/api/cloudkms/v1, use NewService to create the client.
	kmsService, err := cloudkms.NewService(ctx)
	if err != nil {
		log.Fatal(err)
	}

	_ = kmsService
}

Java

GitHub で表示

static void authImplicit() {
  // If you don't specify credentials when constructing the client, the client library will
  // look for credentials via the environment variable GOOGLE_APPLICATION_CREDENTIALS.
  Storage storage = StorageOptions.getDefaultInstance().getService();

  System.out.println("Buckets:");
  Page<Bucket> buckets = storage.list();
  for (Bucket bucket : buckets.iterateAll()) {
    System.out.println(bucket.toString());
  }
}

Node.js

GitHub で表示

// Imports the Google Cloud client library.
const {Storage} = require('@google-cloud/storage');

// Instantiates a client. If you don't specify credentials when constructing
// the client, the client library will look for credentials in the
// environment.
const storage = new Storage();
// Makes an authenticated API request.
async function listBuckets() {
  try {
    const results = await storage.getBuckets();

    const [buckets] = results;

    console.log('Buckets:');
    buckets.forEach(bucket => {
      console.log(bucket.name);
    });
  } catch (err) {
    console.error('ERROR:', err);
  }
}
listBuckets();

PHP

GitHub で表示

// Imports the Cloud Storage client library.
use Google\Cloud\Storage\StorageClient;

function auth_cloud_implicit($projectId)
{
    $config = [
        'projectId' => $projectId,
    ];

    # If you don't specify credentials when constructing the client, the
    # client library will look for credentials in the environment.
    $storage = new StorageClient($config);

    # Make an authenticated API request (listing storage buckets)
    foreach ($storage->buckets() as $bucket) {
        printf('Bucket: %s' . PHP_EOL, $bucket->name());
    }
}

Python

GitHub で表示

def implicit():
    from google.cloud import storage

    # If you don't specify credentials when constructing the client, the
    # client library will look for credentials in the environment.
    storage_client = storage.Client()

    # Make an authenticated API request
    buckets = list(storage_client.list_buckets())
    print(buckets)

Ruby

GitHub で表示

# project_id = "Your Google Cloud project ID"

require "google/cloud/storage"

# If you don't specify credentials when constructing the client, the client
# library will look for credentials in the environment.
storage = Google::Cloud::Storage.new project: project_id

# Make an authenticated API request
storage.buckets.each do |bucket|
  puts bucket.name
end

認証情報を手動で提供する

サービスアカウントが接続されていない環境でアプリケーションを実行する場合は、サービスアカウントを手動で作成する必要があります。その後、1 つ以上のサービスアカウントキーを作成します。これは、サービスアカウントに関連付けられた認証情報です。作成したサービスアカウントキーをアプリケーションに手動で渡します。

サービスアカウントの作成

サービスアカウントがない場合は、次の手順で作成します。

Cloud Console

サービスアカウントを作成します。

Cloud Console で [サービスアカウントの作成] ページに移動します。
[サービスアカウントの作成] に移動
プロジェクトを選択します。
[サービスアカウント名] フィールドに名前を入力します。 Cloud Console は、この名前に基づいて [サービスアカウント ID] フィールドに入力します。

[サービスアカウントの説明] フィールドに説明を入力します。例: Service account for quickstart。
[作成] をクリックします。
[ロールを選択] フィールドをクリックします。

[クイックアクセス] で [基本] をクリックし、[オーナー] をクリックします。

注: [ロール] フィールドは、サービスアカウントがプロジェクト内のどのリソースにアクセスできるかに影響します。これらのロールは後で取り消すことも、追加のロールを付与することもできます。本番環境では、オーナー、編集者、閲覧者のロールを付与しないでください。詳細については、リソースへのアクセス権の付与、変更、取り消しをご覧ください。
[次へ] をクリックします。
[完了] をクリックして、サービスアカウントの作成を完了します。

ブラウザウィンドウを閉じないでください。次のステップでこれを使用します。

サービスアカウントキーを作成します。

Cloud Console で、作成したサービスアカウントのメールアドレスをクリックします。
[キー] をクリックします。
[キーを追加] をクリックし、[新しいキーを作成] をクリックします。
[CREATE] をクリックします。JSON キーファイルがパソコンにダウンロードされます。
[閉じる] をクリックします。

コマンドライン

ローカルマシン上の Cloud SDK を使用するか、または Cloud Shell 内で以下のコマンドを実行できます。

サービスアカウントを作成します。NAME をサービスアカウントの名前に置き換えます。
```
gcloud iam service-accounts create NAME
```
サービスアカウントに権限を付与します。PROJECT_ID を実際のプロジェクト ID に置き換えます。
```
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/owner"
```
注: [--role] フィールドは、サービスアカウントがプロジェクト内のどのリソースにアクセスできるかに影響します。これらのロールは後で取り消すことも、追加のロールを付与することもできます。本番環境では、オーナー、編集者、閲覧者のロールを付与しないでください。詳細については、リソースへのアクセス権の付与、変更、取り消しをご覧ください。
キーファイルを生成します。FILE_NAME はキーファイルの名前に置き換えてください。
```
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
```

環境変数を使用して認証情報を提供する

環境変数 GOOGLE_APPLICATION_CREDENTIALS を設定して、アプリケーションコードに認証情報を指定します。この変数は現在のシェルセッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定します。

Linux または macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH をサービスアカウントキーが含まれる JSON ファイルのパスに置き換えます。

次に例を示します。

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

PowerShell の場合:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH をサービスアカウントキーが含まれる JSON ファイルのパスに置き換えます。

次に例を示します。

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

コマンドプロンプトの場合:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

KEY_PATH をサービスアカウントキーが含まれる JSON ファイルのパスに置き換えます。

この手順を完了すると、上記のセクションで説明したように、認証情報が自動的に検出されます。必要なコードが少なく、さまざまな環境にコードを移植できるため、ADC の使用をおすすめします。

コードを使用して認証情報を提供する

次の例に示すように、サービスアカウントファイルを明示的に参照するコードを使用することもできます。以下のサンプルを実行するには、Cloud Storage クライアントライブラリをインストールする必要があります。

C#

GitHub で表示

        // Some APIs, like Storage, accept a credential in their Create()
        // method.
        public object AuthExplicit(string projectId, string jsonPath)
        {
            // Explicitly use service account credentials by specifying
            // the private key file.
            var credential = GoogleCredential.FromFile(jsonPath);
            var storage = StorageClient.Create(credential);
            // Make an authenticated API request.
            var buckets = storage.ListBuckets(projectId);
            foreach (var bucket in buckets)
            {
                Console.WriteLine(bucket.Name);
            }
            return null;
        }
        // Other APIs, like Language, accept a channel in their Create()
        // method.
        public object AuthExplicit(string projectId, string jsonPath)
        {
            LanguageServiceClientBuilder builder = new LanguageServiceClientBuilder
            {
                CredentialsPath = jsonPath
            };

            LanguageServiceClient client = builder.Build();
            AnalyzeSentiment(client);
            return 0;
        }

Go

GitHub で表示


// explicit reads credentials from the specified path.
func explicit(jsonPath, projectID string) {
	ctx := context.Background()
	client, err := storage.NewClient(ctx, option.WithCredentialsFile(jsonPath))
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Buckets:")
	it := client.Buckets(ctx, projectID)
	for {
		battrs, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			log.Fatal(err)
		}
		fmt.Println(battrs.Name)
	}
}

Java

GitHub で表示

static void authExplicit(String jsonPath) throws IOException {
  // You can specify a credential file by providing a path to GoogleCredentials.
  // Otherwise credentials are read from the GOOGLE_APPLICATION_CREDENTIALS environment variable.
  GoogleCredentials credentials = GoogleCredentials.fromStream(new FileInputStream(jsonPath))
        .createScoped(Lists.newArrayList("https://www.googleapis.com/auth/cloud-platform"));
  Storage storage = StorageOptions.newBuilder().setCredentials(credentials).build().getService();

  System.out.println("Buckets:");
  Page<Bucket> buckets = storage.list();
  for (Bucket bucket : buckets.iterateAll()) {
    System.out.println(bucket.toString());
  }
}

Node.js

GitHub で表示

// Imports the Google Cloud client library.
const {Storage} = require('@google-cloud/storage');

// Instantiates a client. Explicitly use service account credentials by
// specifying the private key file. All clients in google-cloud-node have this
// helper, see https://github.com/GoogleCloudPlatform/google-cloud-node/blob/master/docs/authentication.md
// const projectId = 'project-id'
// const keyFilename = '/path/to/keyfile.json'
const storage = new Storage({projectId, keyFilename});

// Makes an authenticated API request.
async function listBuckets() {
  try {
    const [buckets] = await storage.getBuckets();

    console.log('Buckets:');
    buckets.forEach(bucket => {
      console.log(bucket.name);
    });
  } catch (err) {
    console.error('ERROR:', err);
  }
}
listBuckets();

PHP

GitHub で表示

namespace Google\Cloud\Samples\Auth;

// Imports the Cloud Storage client library.
use Google\Cloud\Storage\StorageClient;

function auth_cloud_explicit($projectId, $serviceAccountPath)
{
    # Explicitly use service account credentials by specifying the private key
    # file.
    $config = [
        'keyFilePath' => $serviceAccountPath,
        'projectId' => $projectId,
    ];
    $storage = new StorageClient($config);

    # Make an authenticated API request (listing storage buckets)
    foreach ($storage->buckets() as $bucket) {
        printf('Bucket: %s' . PHP_EOL, $bucket->name());
    }
}

Python

GitHub で表示

def explicit():
    from google.cloud import storage

    # Explicitly use service account credentials by specifying the private key
    # file.
    storage_client = storage.Client.from_service_account_json(
        'service_account.json')

    # Make an authenticated API request
    buckets = list(storage_client.list_buckets())
    print(buckets)

Ruby

GitHub で表示

# project_id = "Your Google Cloud project ID"
# key_file   = "path/to/service-account.json"
require "google/cloud/storage"

# Explicitly use service account credentials by specifying the private key
# file.
storage = Google::Cloud::Storage.new project: project_id, keyfile: key_file

# Make an authenticated API request
storage.buckets.each do |bucket|
  puts bucket.name
end

認証情報を管理する際のベストプラクティス

機密データにアクセスするには、認証情報が必要です。次の方法で認証情報へのアクセスを保護します。

API キー、OAuth トークン、サービスアカウントキーなど、認証に関する重要な情報をソースコード内に組み込まないでください。代わりに、アプリケーションのソースコードの外部にある認証情報を指す環境変数を使用できます（Cloud Key Management Service など）。
テスト環境と本番環境のように、異なるコンテキストには異なる認証情報を使用してください。
認証情報が第三者に盗まれないように、認証情報の転送には必ず HTTPS などのセキュアチャネルを使用してください。クリアテキストや URL の一部として転送しないようご注意ください。
有効期間が長い認証情報をクライアント側アプリケーションに組み込まないでください。たとえば、モバイルアプリには、サービスアカウントキーを組み込まないでください。クライアント側アプリを調べることは可能なため、認証情報が第三者によって簡単に見つけられて、使用されてしまう可能性があります。
不要になったトークンは無効にしてください。

API エラーのトラブルシューティング

API リクエストが失敗した場合のトラブルシューティング方法について詳しくは、Cloud APIs のエラーをご覧ください。

次のステップ

使ってみる

Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

無料で開始

サービス アカウントとして認証する

認証情報の自動検出

C#

Go

Java

Node.js

PHP

Python

Ruby

認証情報を手動で提供する

サービス アカウントの作成

Cloud Console

コマンドライン

環境変数を使用して認証情報を提供する

Linux または macOS

Windows

コードを使用して認証情報を提供する

C#

Go

Java

Node.js

PHP

Python

Ruby

認証情報を管理する際のベスト プラクティス

API エラーのトラブルシューティング

次のステップ

使ってみる

サービスアカウントとして認証する

サービスアカウントの作成

認証情報を管理する際のベストプラクティス