Menambahkan pengguna ke server SFTP

Dokumen ini menunjukkan cara menambahkan pengguna ke server Cloud FTP. Pengguna seperti partner eksternal dan pemangku kepentingan internal dapat menggunakan server untuk mentransfer file secara aman ke dan dari Cloud Storage.

Secara umum, berikut adalah langkah-langkah untuk menambahkan pengguna ke server SFTP:

  1. Konfigurasikan izin untuk pengguna.
  2. Buat pengguna SFTP dan petakan direktori mereka ke bucket Cloud Storage.

Untuk mengetahui langkah-langkah membuat server, lihat Membuat server SFTP eksternal dan Membuat server SFTP internal.

Pertimbangan

  • Anda dapat memberi pengguna akses ke maksimum 10 bucket.

  • Pengguna dapat memiliki maksimal 10 kunci publik.

Sebelum memulai

  1. Buat satu atau beberapa bucket Cloud Storage untuk menyimpan data yang akan digunakan pengguna, jika bucket belum ada.

  2. Dapatkan kunci publik pengguna dari setiap pasangan kunci SSH yang akan mereka gunakan untuk terhubung ke server.

    Jika pengguna tidak memiliki pasangan kunci SSH, gunakan langkah-langkah berikut untuk membuatnya.

    Membuat pasangan kunci SSH

    Format kunci mana yang Anda perlukan?

    Format kunci yang Anda perlukan bergantung pada klien yang Anda gunakan untuk terhubung ke server SFTP. Untuk informasi selengkapnya, lihat Klien SFTP yang didukung.

    Format PEM

    1. Untuk membuat pasangan kunci OpenSSH (format PEM), gunakan utilitas ssh-keygen.

      Di mesin klien yang akan terhubung ke server SFTP, jalankan perintah berikut:

      ssh-keygen -t rsa -b 4096 -f ~/.ssh/KEY_PAIR_NAME

      Ganti KEY_PAIR_NAME dengan nama untuk pasangan kunci, seperti sftp_user_key.

    2. Ekstrak kunci publik:

      cat ~/.ssh/KEY_PAIR_NAME.pub

    Format PPK

    1. Untuk membuat pasangan kunci PuTTY (format PPK), gunakan alat PuTTYgen.

      Di mesin klien yang akan terhubung ke server SFTP, jalankan perintah berikut:

      puttygen -t rsa -b 4096 -o KEY_PAIR_NAME.ppk

      Ganti KEY_PAIR_NAME dengan nama untuk pasangan kunci, seperti sftp_user_key.

    2. Ekstrak kunci publik:

      puttygen -L KEY_PAIR_NAME.ppk

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan guna menambahkan pengguna SFTP, minta administrator untuk memberi Anda peran IAM FTP Admin (roles/ftp.admin) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin ftp.users.create , yang diperlukan untuk menambahkan pengguna SFTP.

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Mengonfigurasi izin untuk pengguna

  1. Instal Google Cloud CLI. Setelah penginstalan, lakukan inisialisasi Google Cloud CLI dengan menjalankan perintah berikut: 

    gcloud init

    Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

  2. Tetapkan project:

    gcloud config set project PROJECT_ID

    Ganti PROJECT_ID dengan ID project yang berisi server SFTP.

  3. Buat akun layanan untuk pengguna, jika akun layanan belum ada. Akun layanan mengakses resource Cloud Storage atas nama pengguna.

    gcloud iam service-accounts create USERNAME-sa \
    --description="USERNAME SFTP Service Account" \
    --display-name="USERNAME SFTP Service Account"

    Ganti USERNAME dengan nama pengguna unik untuk pengguna SFTP. Nama pengguna harus diawali dengan huruf kecil dan dapat menyertakan huruf kecil, angka, atau tanda hubung. Panjang maksimum adalah 32 karakter.

    Jika berhasil, pesan seperti Created service account [example-userid-sa] akan ditampilkan.

  4. Berikan peran IAM kepada administrator yang membuat pengguna SFTP:

    1. Berikan peran Service Account User (roles/iam.serviceAccountUser) kepada diri Anda sendiri:

      gcloud iam service-accounts add-iam-policy-binding USERNAME-sa@PROJECT_ID.iam.gserviceaccount.com \
    --member="user:ADMINISTRATOR_EMAIL" \
    --role="roles/iam.serviceAccountUser"

      Ganti ADMINISTRATOR_EMAIL dengan alamat email akun utama yang membuat pengguna SFTP. Jika Anda membuat pengguna (bukan aplikasi), nilai ini adalah alamat email yang Anda gunakan untuk mengakses Google Cloud.

      Jika berhasil, pesan seperti berikut akan ditampilkan:

      Updated IAM policy for serviceAccount [example-userid-sa@example-project.iam.gserviceaccount.com].
bindings:
- members:
- user:admin@example.com
role: roles/iam.serviceAccountUser
etag: BwZJk7OiSzw=
version: 1

    2. Beri diri Anda sendiri peran Storage Bucket Viewer (roles/storage.bucketViewer) di bucket: 

      gcloud storage buckets add-iam-policy-binding gs://BUCKET_NAME \
    --member="user:ADMINISTRATOR_EMAIL" \
    --role="roles/storage.bucketViewer"

      Ganti BUCKET_NAME dengan nama bucket.

      Ulangi langkah ini untuk setiap bucket yang perlu diakses pengguna.

    3. Beri diri Anda peran Storage Object Viewer (roles/storage.objectViewer) di bucket:

      gcloud storage buckets add-iam-policy-binding gs://BUCKET_NAME \
    --member="user:ADMINISTRATOR_EMAIL" \
    --role="roles/storage.objectViewer"

      Ulangi langkah ini untuk setiap bucket yang perlu diakses pengguna.

  5. Berikan peran IAM yang diperlukan untuk mengakses bucket kepada akun layanan pengguna:

    gcloud storage buckets add-iam-policy-binding gs://BUCKET_NAME \
    --member="serviceAccount:USERNAME-sa@PROJECT_ID.iam.gserviceaccount.com" \
    --role="ROLE"

    Ganti ROLE dengan salah satu peran IAM berikut:

    • Untuk akses hanya baca, gunakan peran roles/storage.objectViewer.
    • Untuk akses baca dan tulis, gunakan peran roles/storage.objectAdmin.

    Ulangi langkah ini untuk setiap bucket yang perlu diakses pengguna.

  6. Izinkan Agen Layanan Cloud FTP untuk membuat token bagi akun layanan pengguna:

    1. Dapatkan alamat email agen layanan server. Untuk mengetahui langkah-langkahnya, lihat Mendapatkan detail tentang server.

    2. Beri otorisasi Agen Layanan Cloud FTP:

      gcloud iam service-accounts add-iam-policy-binding USERNAME-sa@PROJECT_ID.iam.gserviceaccount.com \
    --member="serviceAccount:SERVICE_AGENT_EMAIL" \
    --role="roles/iam.serviceAccountTokenCreator"

      Ganti SERVICE_AGENT_EMAIL dengan alamat email agen layanan.

Selanjutnya, buat pengguna.

Membuat pengguna server SFTP

Setelah mengonfigurasi izin untuk pengguna, Anda membuat pengguna dan memetakan direktori mereka ke satu atau beberapa bucket Cloud Storage.

gcloud

  1. Untuk membuat pengguna server SFTP, jalankan perintah gcloud alpha storage ftp users create.

    Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

    • CREDENTIAL_NAME: nama unik untuk mengidentifikasi kredensial pengguna.
    • SSH_PUBLIC_KEY: isi kunci publik SSH pengguna, dalam format OpenSSH. Contoh, ssh-rsa AAAAB3NzaC1ycRexample....
    • USERNAME: nama pengguna SFTP.
    • SERVICE_ACCOUNT: akun layanan pengguna. Misalnya, username-sa@example-project.iam.gserviceaccount.com.
    • LOCATION_ID: lokasi server, seperti us-west1.
    • SERVER_ID: ID server.
    • BUCKET_NAME: nama bucket yang aksesnya diberikan kepada pengguna SFTP, seperti example-bucket. Hilangkan gs://.
    • (Opsional) BUCKET_PREFIX: jalur folder dalam bucket yang akan ditetapkan sebagai direktori root untuk pemetaan direktori ini. Jika Anda menghapus properti bucket_prefix, Cloud FTP akan menggunakan root bucket.

    • DIRECTORY: jalur direktori landing logis yang ditampilkan kepada pengguna SFTP. Contoh, /home/uploads.

      Jika Anda memetakan beberapa bucket atau folder, berikan jalur direktori unik untuk setiap pemetaan.

      Direktori logis bertingkat tidak didukung. Jika Anda memberikan beberapa pemetaan untuk sebuah direktori, berikan direktori dalam struktur datar, bukan struktur bertingkat. Misalnya, gunakan /dir1 dan /dir2, bukan /dir1 dan /dir1/dir2.

    • SFTP_PERMISSION: tingkat akses untuk direktori. Untuk akses hanya baca, tetapkan nilai ini ke READ_ONLY. Untuk akses baca dan tulis, tetapkan nilai ini ke READ_WRITE.

    Perhatikan hal berikut:

    • Untuk memberi pengguna akses ke beberapa bucket, berikan flag --storage-directory-mapping beberapa kali, dengan pemetaan direktori untuk setiap bucket.
    • Untuk mengonfigurasi beberapa kunci publik bagi pengguna, berikan beberapa kredensial dalam file credentials.json.

    Simpan konten berikut ini dalam file yang bernama credentials.json: 

    [
  {
    "credentialName": "CREDENTIAL_NAME",
    "credentialType": "PUBLIC_KEY",
    "sshPublicKeyBody": "SSH_PUBLIC_KEY"
  }
]

    Jalankan perintah berikut:

    Linux, macOS, atau Cloud Shell

    gcloud alpha storage ftp users create USERNAME \
    --customer-service-account=SERVICE_ACCOUNT --location=LOCATION_ID \
    --server=SERVER_ID \
    --storage-directory-mapping=bucket=BUCKET_NAME,bucket_prefix=BUCKET_PREFIX,directory=DIRECTORY,permission=SFTP_PERMISSION \
    --user-credentials-from-file=credentials.json

    Windows (PowerShell)

    gcloud alpha storage ftp users create USERNAME `
    --customer-service-account=SERVICE_ACCOUNT --location=LOCATION_ID `
    --server=SERVER_ID `
    --storage-directory-mapping=bucket=BUCKET_NAME,bucket_prefix=BUCKET_PREFIX,directory=DIRECTORY,permission=SFTP_PERMISSION `
    --user-credentials-from-file=credentials.json

    Windows (cmd.exe)

    gcloud alpha storage ftp users create USERNAME ^
    --customer-service-account=SERVICE_ACCOUNT --location=LOCATION_ID ^
    --server=SERVER_ID ^
    --storage-directory-mapping=bucket=BUCKET_NAME,bucket_prefix=BUCKET_PREFIX,directory=DIRECTORY,permission=SFTP_PERMISSION ^
    --user-credentials-from-file=credentials.json
         Perlu waktu beberapa detik untuk membuat pengguna.

  2. Berikan informasi berikut kepada pengguna, yang mereka perlukan untuk terhubung ke server:

    • Nama pengguna SFTP pengguna.

    • Konfigurasi akses server, yang bergantung pada jenis server:

      • Untuk server eksternal, alamat IP server.

      • Untuk server internal, URI lampiran layanan server.

      Untuk mengetahui langkah-langkah mendapatkan konfigurasi akses server, lihat Mendapatkan detail tentang server.

    • (Opsional) Sidik jari kunci server.

REST

  1. Untuk membuat pengguna server SFTP, gunakan metode servers.users.create.

    Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

    • PROJECT_ID: Google Cloud project ID server.
    • LOCATION_ID: lokasi server, seperti us-west1.
    • SERVER_ID: ID server.
    • USERNAME: nama pengguna SFTP pengguna.
    • BUCKET_NAME: nama bucket yang dapat diakses oleh pengguna SFTP, seperti example-bucket. Hilangkan gs://.
    • (Opsional) BUCKET_PREFIX: jalur folder dalam bucket yang akan ditetapkan sebagai direktori root untuk pemetaan direktori ini. Jika Anda menghapus nilai ini, Cloud FTP akan menggunakan root bucket.

    • DIRECTORY: jalur direktori pendaratan logis yang ditampilkan kepada pengguna SFTP. Contoh, /home/uploads. Jika Anda menghapus nilai ini, Cloud FTP akan menetapkan direktori landing ke /.

      Jika Anda memetakan beberapa bucket atau folder, berikan jalur direktori unik untuk setiap pemetaan.

      Direktori logis bertingkat tidak didukung. Jika Anda memberikan beberapa pemetaan untuk sebuah direktori, berikan direktori dalam struktur datar, bukan struktur bertingkat. Misalnya, gunakan /dir1 dan /dir2, bukan /dir1 dan /dir1/dir2.

    • SFTP_PERMISSION: tingkat akses untuk direktori. Untuk akses hanya baca, tetapkan nilai ini ke READ_ONLY. Untuk akses baca dan tulis, tetapkan nilai ini ke READ_WRITE.
    • SERVICE_ACCOUNT: akun layanan pengguna. Misalnya, username-sa@example-project.iam.gserviceaccount.com.
    • CREDENTIAL_NAME: nama unik untuk mengidentifikasi kredensial pengguna.
    • SSH_PUBLIC_KEY: isi kunci publik SSH pengguna, dalam format OpenSSH. Contoh, ssh-rsa AAAAB3NzaC1ycRexample....

    Perhatikan hal berikut:

    • Untuk memberi pengguna akses ke beberapa bucket, berikan beberapa pemetaan bucket dalam daftar storageDirectoryMappings.
    • Untuk mengonfigurasi beberapa kunci publik bagi pengguna, berikan beberapa kredensial dalam daftar userCredentials.

    Metode HTTP dan URL: 

    POST https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID/users?userId=USERNAME

    Meminta isi JSON: 

    {
  "storageDirectoryMappings": [
    {
      "bucket": "BUCKET_NAME",
      "bucketPrefix": "BUCKET_PREFIX",
      "directory": "DIRECTORY",
      "permission": "SFTP_PERMISSION"
    }
  ],
  "customerServiceAccount": "SERVICE_ACCOUNT",
  "userCredentials": [
    {
      "credentialName": "CREDENTIAL_NAME",
      "credentialType": "PUBLIC_KEY",
      "sshPublicKeyBody": "SSH_PUBLIC_KEY"
    }
  ]
}

    Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

    Respons mengidentifikasi operasi yang berjalan lama. Pembuatan pengguna memerlukan waktu beberapa detik.

  2. Berikan informasi berikut kepada pengguna, yang diperlukan untuk terhubung ke server:

    • Nama pengguna SFTP pengguna.

    • Konfigurasi akses server, yang bergantung pada jenis server:

      • Untuk server eksternal, alamat IP server.

      • Untuk server internal, URI lampiran layanan server.

      Untuk mengetahui langkah-langkah mendapatkan konfigurasi akses server, lihat Mendapatkan detail tentang server.

    • (Opsional) Sidik jari kunci server.

Library klien

C#

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API C# Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 

using Google.Cloud.Ftp.V1;
using Google.LongRunning;
using System.Threading.Tasks;

public sealed partial class GeneratedCloudFtpClientSnippets
{
    /// <summary>Snippet for CreateUserAsync</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public async Task CreateUserAsync()
    {
        // Create client
        CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
        // Initialize request argument(s)
        string parent = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
        User user = new User();
        string userId = "";
        // Make the request
        Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(parent, user, userId);

        // Poll until the returned long-running operation is complete
        Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
        // Retrieve the operation result
        User result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            User retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API Go Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 


//go:build examples

package main

import (
	"context"

	ftp "cloud.google.com/go/ftp/apiv1"
	ftppb "cloud.google.com/go/ftp/apiv1/ftppb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := ftp.NewCloudFtpRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &ftppb.CreateUserRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/ftp/apiv1/ftppb#CreateUserRequest.
	}
	op, err := c.CreateUser(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Java Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 

import com.google.api.core.ApiFuture;
import com.google.cloud.ftp.v1.CloudFtpClient;
import com.google.cloud.ftp.v1.CreateUserRequest;
import com.google.cloud.ftp.v1.ServerName;
import com.google.cloud.ftp.v1.User;
import com.google.longrunning.Operation;

public class AsyncCreateUser {

  public static void main(String[] args) throws Exception {
    asyncCreateUser();
  }

  public static void asyncCreateUser() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CloudFtpClient cloudFtpClient = CloudFtpClient.create()) {
      CreateUserRequest request =
          CreateUserRequest.newBuilder()
              .setParent(ServerName.of("[PROJECT]", "[LOCATION]", "[SERVER]").toString())
              .setUserId("userId-836030906")
              .setUser(User.newBuilder().build())
              .setRequestId("requestId693933066")
              .build();
      ApiFuture<Operation> future = cloudFtpClient.createUserCallable().futureCall(request);
      // Do something.
      Operation response = future.get();
    }
  }
}

Node.js

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Node.js Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Value for parent.
 */
// const parent = 'abc123'
/**
 *  Required. A unique user ID for the SFTP user. The user ID must start with a
 *  lowercase letter and can include lowercase letters, numbers, or hyphens.
 */
// const userId = 'abc123'
/**
 *  Required. The resource being created
 */
// const user = {}
/**
 *  Optional. An optional request ID to identify requests. Specify a unique
 *  request ID so that if you must retry your request, the server will know to
 *  ignore the request if it has already been completed. The server will
 *  guarantee that for at least 60 minutes since the first request.
 *  For example, consider a situation where you make an initial request and the
 *  request times out. If you make the request again with the same request
 *  ID, the server can check if original operation with the same request ID
 *  was received, and if so, will ignore the second request. This prevents
 *  clients from accidentally creating duplicate commitments.
 *  The request ID must be a valid UUID with the exception that zero UUID is
 *  not supported (00000000-0000-0000-0000-000000000000).
 */
// const requestId = 'abc123'

// Imports the Ftp library
const {CloudFtpClient} = require('@google-cloud/ftp').v1;

// Instantiates a client
const ftpClient = new CloudFtpClient();

async function callCreateUser() {
  // Construct request
  const request = {
    parent,
    userId,
    user,
  };

  // Run request
  const [operation] = await ftpClient.createUser(request);
  const [response] = await operation.promise();
  console.log(response);
}

callCreateUser();

PHP

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API PHP Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Ftp\V1\Client\CloudFtpClient;
use Google\Cloud\Ftp\V1\CreateUserRequest;
use Google\Cloud\Ftp\V1\StorageDirectoryMapping;
use Google\Cloud\Ftp\V1\StorageDirectoryMapping\Permission;
use Google\Cloud\Ftp\V1\User;
use Google\Cloud\Ftp\V1\UserCredential;
use Google\Cloud\Ftp\V1\UserCredential\Type;
use Google\Rpc\Status;

/**
 * Creates a new User in a given project and location and Server.
 *
 * @param string $formattedParent                        Value for parent. Please see
 *                                                       {@see CloudFtpClient::serverName()} for help formatting this field.
 * @param string $userId                                 A unique user ID for the SFTP user. The user ID must start with a
 *                                                       lowercase letter and can include lowercase letters, numbers, or hyphens.
 * @param string $userCustomerServiceAccount             Service account in customer project attached to this SFTP User.
 * @param string $userUserCredentialsCredentialName      Name of the user credential.
 * @param int    $userUserCredentialsCredentialType      Type of credential.
 * @param string $userStorageDirectoryMappingsBucket     Name of the bucket.
 * @param string $userStorageDirectoryMappingsDirectory  Directory where the user lands in the SFTP server.
 * @param int    $userStorageDirectoryMappingsPermission Permission to the bucket.
 */
function create_user_sample(
    string $formattedParent,
    string $userId,
    string $userCustomerServiceAccount,
    string $userUserCredentialsCredentialName,
    int $userUserCredentialsCredentialType,
    string $userStorageDirectoryMappingsBucket,
    string $userStorageDirectoryMappingsDirectory,
    int $userStorageDirectoryMappingsPermission
): void {
    // Create a client.
    $cloudFtpClient = new CloudFtpClient();

    // Prepare the request message.
    $userCredential = (new UserCredential())
        ->setCredentialName($userUserCredentialsCredentialName)
        ->setCredentialType($userUserCredentialsCredentialType);
    $userUserCredentials = [$userCredential];
    $storageDirectoryMapping = (new StorageDirectoryMapping())
        ->setBucket($userStorageDirectoryMappingsBucket)
        ->setDirectory($userStorageDirectoryMappingsDirectory)
        ->setPermission($userStorageDirectoryMappingsPermission);
    $userStorageDirectoryMappings = [$storageDirectoryMapping];
    $user = (new User())
        ->setCustomerServiceAccount($userCustomerServiceAccount)
        ->setUserCredentials($userUserCredentials)
        ->setStorageDirectoryMappings($userStorageDirectoryMappings);
    $request = (new CreateUserRequest())
        ->setParent($formattedParent)
        ->setUserId($userId)
        ->setUser($user);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudFtpClient->createUser($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var User $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CloudFtpClient::serverName('[PROJECT]', '[LOCATION]', '[SERVER]');
    $userId = '[USER_ID]';
    $userCustomerServiceAccount = '[CUSTOMER_SERVICE_ACCOUNT]';
    $userUserCredentialsCredentialName = '[CREDENTIAL_NAME]';
    $userUserCredentialsCredentialType = Type::TYPE_UNSPECIFIED;
    $userStorageDirectoryMappingsBucket = '[BUCKET]';
    $userStorageDirectoryMappingsDirectory = '[DIRECTORY]';
    $userStorageDirectoryMappingsPermission = Permission::PERMISSION_UNSPECIFIED;

    create_user_sample(
        $formattedParent,
        $userId,
        $userCustomerServiceAccount,
        $userUserCredentialsCredentialName,
        $userUserCredentialsCredentialType,
        $userStorageDirectoryMappingsBucket,
        $userStorageDirectoryMappingsDirectory,
        $userStorageDirectoryMappingsPermission
    );
}

Python

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Python Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import ftp_v1


def sample_create_user():
    # Create a client
    client = ftp_v1.CloudFtpClient()

    # Initialize request argument(s)
    user = ftp_v1.User()
    user.customer_service_account = "customer_service_account_value"
    user.user_credentials.credential_name = "credential_name_value"
    user.user_credentials.credential_type = "PUBLIC_KEY"
    user.storage_directory_mappings.bucket = "bucket_value"
    user.storage_directory_mappings.directory = "directory_value"
    user.storage_directory_mappings.permission = "READ_WRITE"

    request = ftp_v1.CreateUserRequest(
        parent="parent_value",
        user_id="user_id_value",
        user=user,
    )

    # Make the request
    operation = client.create_user(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Untuk mempelajari cara menginstal dan menggunakan library klien untuk Cloud FTP, lihat Library klien Cloud FTP. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API Ruby Cloud FTP.

Untuk melakukan autentikasi ke Cloud FTP, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal. 

require "google/cloud/ftp/v1"

##
# Snippet for the create_user call in the CloudFtp service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Ftp::V1::CloudFtp::Rest::Client#create_user.
#
def create_user
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Ftp::V1::CloudFtp::Rest::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Ftp::V1::CreateUserRequest.new

  # Call the create_user method.
  result = client.create_user request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

Langkah berikutnya