Supprimer des utilisateurs d'un serveur SFTP

Ce document explique comment supprimer un utilisateur d'un serveur Cloud FTP.

Rôles requis

Pour obtenir l'autorisation nécessaire pour supprimer des utilisateurs SFTP, demandez à votre administrateur de vous accorder le rôle IAM Administrateur FTP (roles/ftp.admin) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient l' ftp.users.delete autorisation, qui est nécessaire pour supprimer des utilisateurs SFTP.

Vous pouvez également obtenir cette autorisation avec des rôles personnalisés ou d'autres rôles prédéfinis.

Supprimer un utilisateur SFTP

gcloud

  1. Supprimez le compte de service qui accède aux ressources Cloud Storage au nom de l'utilisateur :

    1. Récupérez l'adresse e-mail du compte de service de l'utilisateur. Par exemple, USERNAME-sa@PROJECT_ID.. Pour connaître la procédure à suivre, consultez Obtenir des informations sur un utilisateur.

    2. Supprimez le compte de service :

      gcloud iam service-accounts delete SERVICE_ACCOUNT

      Remplacez SERVICE_ACCOUNT par l'adresse e-mail du compte de service.

  2. Pour supprimer l'utilisateur d'un serveur SFTP, exécutez la gcloud alpha storage ftp users delete commande.

    Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

    • USERNAME : nom d'utilisateur SFTP.
    • LOCATION_ID : emplacement du serveur, tel que us-west1.
    • SERVER_ID : ID du serveur.

    Exécutez la commande suivante :

    Linux, macOS ou Cloud Shell

    gcloud alpha storage ftp users delete USERNAME --location=LOCATION_ID \
        --server=SERVER_ID

    Windows (PowerShell)

    gcloud alpha storage ftp users delete USERNAME --location=LOCATION_ID `
        --server=SERVER_ID

    Windows (cmd.exe)

    gcloud alpha storage ftp users delete USERNAME --location=LOCATION_ID ^
        --server=SERVER_ID
    La suppression de l'utilisateur prend quelques secondes.

REST

  1. Supprimez le compte de service qui accède aux ressources Cloud Storage au nom de l'utilisateur :

    1. Récupérez l'adresse e-mail du compte de service de l'utilisateur. Par exemple, USERNAME-sa@PROJECT_ID.. Pour connaître la procédure à suivre, consultez Obtenir des informations sur un utilisateur.

    2. Supprimez le compte de service :

      gcloud iam service-accounts delete SERVICE_ACCOUNT

      Remplacez SERVICE_ACCOUNT par l'adresse e-mail du compte de service.

  2. Pour supprimer l'utilisateur d'un serveur SFTP, utilisez la servers.users.delete méthode.

    Avant d'utiliser les données de la requête, effectuez les remplacements suivants :

    • PROJECT_ID : ID du Google Cloud projet.
    • LOCATION_ID : emplacement du serveur, tel que us-west1.
    • SERVER_ID : ID du serveur.
    • USERNAME : nom d'utilisateur SFTP.

    Méthode HTTP et URL :

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

    Pour envoyer votre requête, développez l'une des options suivantes :

    La réponse identifie une opération de longue durée. La suppression de l'utilisateur prend quelques secondes.

Bibliothèques clientes

C#

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l' API Cloud FTP C#.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public sealed partial class GeneratedCloudFtpClientSnippets
{
    /// <summary>Snippet for DeleteUserAsync</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 DeleteUserAsync()
    {
        // Create client
        CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
        // Initialize request argument(s)
        string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
        // Make the request
        Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(name);

        // Poll until the returned long-running operation is complete
        Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
        // Retrieve the operation result
        Empty 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<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Empty retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l'API Cloud FTPGo.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.


//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.DeleteUserRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/ftp/apiv1/ftppb#DeleteUserRequest.
	}
	op, err := c.DeleteUser(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

Java

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l'API Java Cloud FTP.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

import com.google.api.core.ApiFuture;
import com.google.cloud.ftp.v1.CloudFtpClient;
import com.google.cloud.ftp.v1.DeleteUserRequest;
import com.google.cloud.ftp.v1.UserName;
import com.google.longrunning.Operation;

public class AsyncDeleteUser {

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

  public static void asyncDeleteUser() 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()) {
      DeleteUserRequest request =
          DeleteUserRequest.newBuilder()
              .setName(UserName.of("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]").toString())
              .setForce(true)
              .build();
      ApiFuture<Operation> future = cloudFtpClient.deleteUserCallable().futureCall(request);
      // Do something.
      future.get();
    }
  }
}

Node.js

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l'API Cloud FTP Node.js.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * 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. Name of the resource
 */
// const name = 'abc123'
/**
 *  Optional. If set to true, the request will force the deletion of the User.
 */
// const force = true

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

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

async function callDeleteUser() {
  // Construct request
  const request = {
    name,
  };

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

callDeleteUser();

PHP

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l'API Cloud FTPPHP.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Ftp\V1\Client\CloudFtpClient;
use Google\Cloud\Ftp\V1\DeleteUserRequest;
use Google\Rpc\Status;

/**
 * Deletes a single User.
 *
 * @param string $formattedName Name of the resource
 *                              Please see {@see CloudFtpClient::userName()} for help formatting this field.
 */
function delete_user_sample(string $formattedName): void
{
    // Create a client.
    $cloudFtpClient = new CloudFtpClient();

    // Prepare the request message.
    $request = (new DeleteUserRequest())
        ->setName($formattedName);

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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
{
    $formattedName = CloudFtpClient::userName('[PROJECT]', '[LOCATION]', '[SERVER]', '[USER]');

    delete_user_sample($formattedName);
}

Python

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l'API Cloud FTP Python.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

# 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_delete_user():
    # Create a client
    client = ftp_v1.CloudFtpClient()

    # Initialize request argument(s)
    request = ftp_v1.DeleteUserRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Pour savoir comment installer et utiliser la bibliothèque cliente pour Cloud FTP, consultez Bibliothèques clientes Cloud FTP. Pour en savoir plus, consultez la documentation de référence de l'API Cloud FTP Ruby.

Pour vous authentifier auprès de Cloud FTP, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/ftp/v1"

##
# Snippet for the delete_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#delete_user.
#
def delete_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::DeleteUserRequest.new

  # Call the delete_user method.
  result = client.delete_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

Étape suivante