SFTP ユーザー情報を取得する

このドキュメントでは、Cloud FTP ユーザーに関する情報を取得する方法について説明します。サーバーのすべてのユーザーを一覧表示できます。また、ユーザーの Cloud Storage ディレクトリ マッピングや権限など、特定のユーザーに関する詳細情報を取得することもできます。

必要なロール

SFTP ユーザーに関する情報を取得するために必要な権限を取得するには、プロジェクトに対するCloud FTP 閲覧者 （roles/ftp.viewer）IAM ロールの付与を管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには SFTP ユーザーに関する情報を取得するために必要な権限が設定されています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

SFTP ユーザーに関する情報を取得するには、次の権限が必要です。

• ユーザーを一覧表示する: ftp.users.list
• ユーザーの詳細を取得する: ftp.users.get

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

ユーザーを一覧表示する

REST

サーバーの SFTP ユーザーを一覧表示するには、 servers.users.list メソッドを使用します。

リクエストのデータを使用する前に、 次のように置き換えます。

• PROJECT_ID: Google Cloud プロジェクト ID。
• LOCATION_ID：サーバーのロケーション（us-west1 など）。
• SERVER_ID: サーバー ID。

HTTP メソッドと URL:

GET https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users" | Select-Object -Expand Content

レスポンスの本文は、 User リソースのリストを含む JSON オブジェクトです。

ユーザーの詳細を取得する

特定のユーザーに関する詳細情報（ユーザーの Cloud Storage ディレクトリ マッピングと権限、ユーザーに代わって Cloud Storage リソースにアクセスするサービス アカウントのメールアドレス、ユーザーの認証情報など）を取得するには、次の手順を行います。

REST

SFTP ユーザーの詳細を取得するには、 servers.users.get メソッドを使用します。

リクエストのデータを使用する前に、 次のように置き換えます。

• PROJECT_ID: Google Cloud プロジェクト ID。
• LOCATION_ID：サーバーのロケーション（us-west1 など）。
• SERVER_ID: SFTP サーバー ID。
• USERNAME: SFTP ユーザーのユーザー名。

HTTP メソッドと URL:

GET https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users/USERNAME

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users/USERNAME"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users/USERNAME" | Select-Object -Expand Content

レスポンスの本文は User リソースです。