Esta página explica cómo crear y administrar cuentas de servicio usando el
API de Identity and Access Management (IAM), la consola de Google Cloud y la
comando gcloud-
herramienta de línea
De manera predeterminada, cada proyecto puede tener hasta 100 cuentas de servicio que controlan el acceso a sus recursos. Puede solicitar un aumento de cuota si es necesario. Más información sobre cuotas y límites
## Antes de que empieces
Habilitar la API de IAM
Comprender las cuentas de servicio de IAM
Instalar la CLI de Google Cloud
Funciones requeridas
Para obtener los permisos que necesita para administrar cuentas de servicio, solicite a su administrador que le otorgue los siguientes roles de IAM en el proyecto:
-
Para ver cuentas de servicio y metadatos de cuentas de servicio:
Ver cuentas de servicio (
roles/iam.serviceAccountViewer)
-
Para ver y crear cuentas de servicio:
Crear cuentas de servicio (
roles/iam.serviceAccountCreator)
-
Para ver y eliminar cuentas de servicio:
Eliminar cuentas de servicio (
roles/iam.serviceAccountDeleter)
-
Para administrar completamente (ver, crear, actualizar, deshabilitar, habilitar, eliminar, recuperar y administrar el acceso a) cuentas de servicio:
Administrador de cuenta de servicio (
roles/iam.serviceAccountAdmin)
Para obtener más información sobre cómo otorgar roles, consulte Administrar acceso
Para obtener más información sobre estos roles, consulte Roles de cuentas de servicio
Los roles básicos de IAM también contienen permisos para administrar cuentas de servicio. No debe otorgar roles básicos en un entorno de producción, pero puede otorgarlos en un entorno de desarrollo o prueba.
## Crear una cuenta de servicio
Cuando crea una cuenta de servicio, debe proporcionar una identificación alfanumérica
(
en los ejemplos a continuación), tales como
`SA_NOMBRE`
mi-cuenta-de-servicio. El ID debe tener entre 6 y 30 caracteres y puede
contener caracteres alfanuméricos en minúsculas y guiones. Después de crear un servicio
cuenta, no puede cambiar su nombre
El nombre de la cuenta de servicio aparece en la dirección de correo electrónico que se proporciona
durante la creación, en el formato
`SA_NAME`@ `PROJECT_ID`.iam.gserviceaccount.com
Cada cuenta de servicio también tiene una identificación numérica única y permanente, que se genera automáticamente
También proporciona la siguiente información cuando crea una cuenta de servicio:
es una descripción opcional para la cuenta de servicio
SA_DESCRIPCIÓN
es un nombre descriptivo para la cuenta de servicio
SA_DISPLAY_NAME
es el ID de tu proyecto de Google Cloud
PROJECTO ID
Después de crear una cuenta de servicio, es posible que deba esperar 60 segundos o más antes de usar la cuenta de servicio. Este comportamiento se produce porque las operaciones de lectura finalmente son coherentes; la nueva cuenta de servicio puede tardar en hacerse visible. Si intenta leer o usar una cuenta de servicio inmediatamente después de crearla y recibe un error, puede volver a intentar la solicitud con un retroceso exponencial.
Consola
En la consola de Google Cloud, ve a la
Crear página de cuenta de servicio
Ir a Crear cuenta de servicio
Seleccione un proyecto en la nube
Ingrese un nombre de cuenta de servicio para mostrar en la consola de Google Cloud
La consola de Google Cloud genera un ID de cuenta de servicio basado en este nombre. Edite la identificación si es necesario. No puede cambiar la identificación más tarde
Opcional: Ingrese una descripción de la cuenta de servicio
Si no desea establecer controles de acceso ahora, haga clic en
Hechopara terminar de crear la cuenta de servicio
Para establecer controles de acceso ahora, haga clic en
Crear y continuary continuar con el siguiente paso
Opcional: elija uno o más roles de IAM para otorgar a la cuenta de servicio en el proyecto
Cuando haya terminado de agregar funciones, haga clic en
Continuar
Opcional: En el
Campo de roles de los usuarios de la cuenta de servicio, agregar miembros que pueden hacerse pasar por la cuenta de servicio
Opcional: En el
Campo de roles de administradores de cuentas de servicio, agregue miembros que puedan administrar la cuenta de servicio
Hacer clic
Hechopara terminar de crear la cuenta de servicio
CLI de gcloud
Para crear la cuenta de servicio, ejecute el
comando de creación de cuentas de servicio de gcloud iam:
creación de cuentas de servicio de gcloud iam
SA_NAME\ --description="DESCRIPCIÓN"\ --display-name="DISPLAY_NAME"Reemplace los siguientes valores:
: el nombre de la cuenta de servicio
SA_NOMBRE
: una descripción opcional de la cuenta de servicio
DESCRIPCIÓN
: un nombre de cuenta de servicio para mostrar en la consola de Google Cloud
NOMBRE PARA MOSTRAR
-
Opcional: Para otorgar a su cuenta de servicio un rol de IAM en su proyecto, ejecute el
gcloud proyectos add-iam-policy-bindingcommand:
proyectos de gcloud add-iam-policy-binding
PROJECT_ID\ --member="serviceAccount: SA_NAME@ PROJECT_ID.iam.gserviceaccount.com"\ --role="ROLE_NAME"Reemplace los siguientes valores:
: el ID del proyecto
PROJECTO ID
: el nombre de la cuenta de servicio
SA_NOMBRE
: un nombre de función, como
NOMBRE DE ROL
roles/compute.osIniciar sesión
-
Opcional: para permitir que los usuarios suplanten la cuenta de servicio, ejecute el
gcloud iam service-accounts add-iam-policy-bindingcommand para otorgar a un usuario la función de usuario de cuenta de servicio (
roles/iam.serviceAccountUser) en la cuenta de servicio:
gcloud iam service-accounts add-iam-policy-binding SA_NAME@ PROJECT_ID.iam.gserviceaccount.com \ --member="user: USER_EMAIL"\ --role="roles/iam.serviceAccountUser"Reemplace los siguientes valores:
: el ID del proyecto
PROJECTO ID
: el nombre de la cuenta de servicio
SA_NOMBRE
: la dirección de correo electrónico del usuario
USUARIO_EMAIL
-
DESCANSAR
El
serviceAccounts.create
método crea una cuenta de servicio
Antes de utilizar cualquiera de los datos de la solicitud, realice los siguientes reemplazos:
: su ID de proyecto de Google Cloud. Los ID de proyecto son cadenas alfanuméricas, como
PROJECTO ID
mi proyecto
: El ID alfanumérico de su cuenta de servicio. Este nombre debe tener entre 6 y 30 caracteres y puede contener caracteres alfanuméricos en minúsculas y guiones.
SA_NOMBRE
: Opcional. Una descripción de la cuenta de servicio.
SA_DESCRIPCIÓN
: un nombre legible por humanos para la cuenta de servicio
SA_DISPLAY_NAME
Método HTTP y URL:
PUBLICAR httpsiam.googleapis.com/v1/projects/
PROJECT_ID/cuentas de servicio
Solicitar cuerpo JSON:
{ "ID de la cuenta": "SA_NAME", "serviceAccount": { "descripción": "SA_DESCRIPTION", "displayName": "SA_DISPLAY_NAME"} }
Para enviar su solicitud, expanda una de estas opciones:
curl (Linux, macOS o Cloud Shell)
Guarde el cuerpo de la solicitud en un archivo llamado
solicitud.json,
y ejecuta el siguiente comando:
curl -X POST -H "Autorización: Portador $(gcloud auth print-access-token)"-H "Content-Type: application/json; charset=utf-8"-d @request.json "httpsiam.googleapis.com /v1/proyectos/
PROJECT_ID/cuentas de servicio"PowerShell (Windows)
Guarde el cuerpo de la solicitud en un archivo llamado
solicitud.json,
y ejecuta el siguiente comando:
$cred = autenticación de gcloud token de acceso de impresión
$cabeceras = @{ "Autorización"= "Crédito $portador"}
Invocar-WebRequest `
-Método POST `
-Encabezados $encabezados `
-ContentType: "aplicación/json; charset=utf-8"`
-Solicitud InFile.json `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts"| Seleccionar-Objeto -Expandir contenido
Explorador de API (navegador)
Copie el cuerpo de la solicitud y abra el
página de referencia del método
El panel API Explorer se abre en el lado derecho de la página.
Puede interactuar con esta herramienta para enviar solicitudes
Pegue el cuerpo de la solicitud en esta herramienta, complete cualquier otro campo obligatorio y haga clic en
**Ejecutar**
Debería recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/my-project/serviceAccounts/
[email protected]", "projectId": "my-project", "uniqueId": "123456789012345678901", "email": "
[email protected]", "displayName": "Mi cuenta de servicio", "etag": "BwUp3rVlzes "description": "Una cuenta de servicio para ejecutar trabajos en mi proyecto", "oauth2ClientId": "987654321098765432109"}
C++
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API C++ de IAM.
espacio de nombres iam = ::google::cloud::iam; std::string const& project_id, std::string const& account_id, std::string const& display_name, std::string const& descripción) { iam::IAMClient client(iam::MakeIAMConnection google::iam::admin::v1::ServiceAccount service_account; service_account.set_display_name(display_name); service_account.set_description(descripción); respuesta automática = client.CreateServiceAccount("projects/ "+ project_id, account_id, service_account); if (!response) throw std::runtime_error(response.statusmessage std::cout<< "Cuenta de servicio creada con éxito: "<< respuesta->DebugString()<< ""; }
C#
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API C# de IAM.
utilizando el sistema; utilizando Google.Apis.Auth.OAuth2; utilizando Google.Apis.Iam.v1; utilizando Google.Apis.Iam.v1.Data; ServiceAccounts de clase parcial pública { Public static ServiceAccount CreateServiceAccount(string projectId, string name, string displayName) { var credential = GoogleCredential.GetApplicationDefault() .CreateScoped(IamService.Scope.CloudPlatform); var service = new IamService(new IamService.Initializer { HttpClientInitializer = credentialvar request = new CreateServiceAccountRequest { AccountId = nombre, ServiceAccount = new ServiceAccount { DisplayName = displayName } }; var serviceAccount = service.Projects.ServiceAccounts.Create( request, "projects/ "+ projectId). Ejecute Console.WriteLine ("Cuenta de servicio creada: "+ serviceAccount.Email); return serviceAccount; } }
Vamos
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API Go de IAM.
import ("context""fmt""io"iam "google.golang.org/api/iam/v1") // createServiceAccount crea una cuenta de servicio. func createServiceAccount(wi io.Writer, projectID, name, displayName string) (*iam.ServiceAccount, error) { ctx := context.Background() service, err := iam.NewService(ctx) if err != nil { return nil, fmt.Errorf("iam.NewService: %v", err) } request :=&iam.CreateServiceAccountRequest{ AccountId: nombre, ServiceAccount:&iam.ServiceAccount{ DisplayName: displayName, }, } cuenta, err := service.Projects.ServiceAccounts.Create("projectsprojectID, request).Do() if err != nil { return nil, fmt.Errorf("Projects.ServiceAccounts.Create: %v", err) } fmt.Fprintf(w, "Cuenta de servicio creada: %v", cuenta) devolver cuenta, nil }
Java
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API Java de IAM.
importar com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; importar com.google.api.client.json.jackson2.JacksonFactory; importar com.google.api.services.iam.v1.Iam; importar com.google.api.services.iam.v1.IamScopes; importar com.google.api.services.iam.v1.model.CreateServiceAccountRequest; importar com.google.api.services.iam.v1.model.ServiceAccount; importar com.google.auth.http.HttpCredentialsAdapter; importar com.google.auth.oauth2.GoogleCredentials; importar java.io.IOException; importar java.security.GeneralSecurityException; importar java.util.Collections; public class CreateServiceAccount { // Crea una cuenta de servicio. public static void createServiceAccount(String projectId, String serviceAccountName) { // String projectId = "my-project-id"; // String serviceAccountName = "mi-servicio-nombre-de-cuenta"; Soy servicio = nulo; intente { servicio = initService } catch (IOException | GeneralSecurityException e) { System.out.println("No se puede inicializar el servicio:
"+ e.toString return; } try { ServiceAccount serviceAccount = new ServiceAccount serviceAccount.setDisplayName("your-display-name CreateServiceAccountRequest request = new CreateServiceAccountRequest request.setAccountId(serviceAccountName); request.setServiceAccount(serviceAccount); serviceAccount = service.projectsserviceAccountscreate( "projects/"+ projectId, request).execute System.out.println("Cuenta de servicio creada: "+ serviceAccount.getEmail } catch (IOException e) { System.out.println("No se pudo crear la cuenta de servicio:
"+ e.toString } } private static Iam initService() lanza GeneralSecurityException, IOException { // Use la estrategia de credenciales predeterminadas de la aplicación para la autenticación. Para obtener más información, consulte: // httpscloud.google.com/docs/authentication/production#finding_credentials_automatically Credencial de GoogleCredentials = GoogleCredentials.getApplicationDefault() .createScoped(Collections.singleton(IamScopes.CLOUD_PLATFORM // Inicializa el servicio IAM, que se puede usar para enviar solicitudes a la API de IAM. Iam service = new Iam.Builder( GoogleNetHttpTransport.newTrustedTransport JacksonFactory. getDefaultInstance new HttpCredentialsAdapter(credencial)) .setApplicationName("service-accounts") .build return service; } }
Pitón
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API Python de IAM.
import os from google.oauth2 import service_account import googleapiclient.discovery def create_service_account(project_id, name, display_name): Crea una cuenta de servicio credenciales = service_account.Credentials.from_service_account_file( filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS scopeshttpswww.googleapis.com/auth/ servicio de plataforma en la nube = googleapiclient.discovery.build( 'iam', 'v1', credenciales=credenciales) my_service_account = service.projectsserviceAccountscreate( name='projects/'+ project_id, body={ 'accountId': nombre, 'serviceAccount': { 'displayName': display_name } execute() print('Cuenta de servicio creada: '+ my_service_account['email return my_service_account
Después de crear una cuenta de servicio, otorgue uno o más roles a la cuenta de servicio para que pueda actuar en su nombre.
Además, si la cuenta de servicio necesita acceder a recursos en otros proyectos, generalmente debe habilitar las API para esos recursos en el proyecto donde creó la cuenta de servicio.
## Listado de cuentas de servicio
Puede enumerar sus cuentas de servicio para ayudarlo a auditar cuentas de servicio y claves, o como parte de una herramienta personalizada para administrar cuentas de servicio.
Consola
En la consola de Google Cloud, ve a la
página de cuentas de servicio
Seleccione un proyecto
Él
La página Cuentas de servicio enumera todas las cuentas de servicio administradas por el usuario en el proyecto que seleccionó. La página no incluye cuentas de servicio administradas por Google.
CLI de gcloud
Ejecutar el
lista de cuentas de servicio de gcloud iam
comando para enumerar todas las cuentas de servicio en un proyecto
Dominio:
lista de cuentas de servicio de gcloud iam
El resultado es la lista de todas las cuentas de servicio en el proyecto:
NOMBRE CORREO ELECTRONICO
SA_DISPLAY_NAME_1 SA_NAME_1@ PROJECT_ID.iam.gserviceaccount.com SA_DISPLAY_NAME_2 SA_NAME_2@ PROJECT_ID.iam.gserviceaccount.com
DESCANSAR
El
serviceAccounts.list
método enumera cada cuenta de servicio en su proyecto
Antes de utilizar cualquiera de los datos de la solicitud, realice los siguientes reemplazos:
: su ID de proyecto de Google Cloud. Los ID de proyecto son cadenas alfanuméricas, como
PROJECTO ID
mi proyecto
Método HTTP y URL:
OBTENGA httpsiam.googleapis.com/v1/projects/
PROJECT_ID/cuentas de servicio
Para enviar su solicitud, expanda una de estas opciones:
curl (Linux, macOS o Cloud Shell)
Ejecute el siguiente comando:
curl -X GET -H "Autorización: Portador $(gcloud auth print-access-token)""httpsiam.googleapis.com/v1/projects/
PROJECT_ID/cuentas de servicio"PowerShell (Windows)
Ejecute el siguiente comando:
$cred = autenticación de gcloud token de acceso de impresión
$cabeceras = @{ "Autorización"= "Crédito $portador"}
Invocar-WebRequest `
-Método OBTENER `
-Encabezados $encabezados `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts"| Seleccionar-Objeto -Expandir contenido
Explorador de API (navegador)
Abre el
página de referencia del método
El panel API Explorer se abre en el lado derecho de la página.
Puede interactuar con esta herramienta para enviar solicitudes
Complete los campos obligatorios y haga clic en
**Ejecutar**
Debería recibir una respuesta JSON similar a la siguiente:
{ "cuentas": [ { "nombre": "proyectos/mi-proyecto/cuentasdeservicio/
[email protected]", "projectId": "mi-proyecto", "uniqueId": "123456789012345678901", "email": "
[email protected]", "description": "Mi primera cuenta de servicio", "displayName": "Cuenta de servicio 1", "etag": "BwUpTsLVUkQ "oauth2ClientId": "987654321098765432109"}, { "name": "projects/my-project/serviceAccounts/
[email protected]", "projectId": "my-project", "uniqueId ": "234567890123456789012", "email": "
[email protected]", "description": "Mi segunda cuenta de servicio", "displayName": "Cuenta de servicio 2", "etag": "UkQpTwBVUsL "oauth2ClientId": "876543210987654321098"} ] }
C++
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API de C++ de IAM.
espacio de nombres iam = ::google::cloud::iam; std::const de cadena& project_id) { iam::IAMClient client(iam::MakeIAMConnection int count = 0; for (auto const& sa : client.ListServiceAccounts("projects/"+ project_id)) { if (!sa) throw std::runtime_error(sa.statusmessage std::cout<< "ServiceAccount recuperada con éxito: "<< sa->name()<< ""; ++recuento; } if (recuento == 0) { std::cout<< "No se encontraron cuentas de servicio en el proyecto: "<< project_id<< ""; } }
C#
Para obtener información sobre cómo instalar y usar la biblioteca de cliente para IAM, consulte Bibliotecas de cliente de IAM. Para obtener más información, consulte la documentación de referencia de la API C# de IAM.
utilizando el sistema; usando System.Collections.Generic; utilizando Google.Apis.Auth.OAuth2; usando Google.Apis.Iam.v1; utilizando Google.Apis.Iam.v1.Data; Clase parcial pública ServiceAccounts { public static IList
ListServiceAccounts(string projectId) { var credential = GoogleCredential.GetApplicationDefault() .CreateScoped(IamService.Scope.CloudPlatform); var service = new IamService(new IamService.Initializer { HttpClientInitializer = credentialvar response = service.Projects.ServiceAccounts.List( "projects/" + projectId).Execute foreach (ServiceAccount account in response.Accounts) { Console.WriteLine("Name: " + account.Name); Console.WriteLine("Display Name: " + account.DisplayName); Console.WriteLine("Email: " + account.Email); Console.WriteLine } return response.Accounts; } }
Go
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Go API reference documentation
import ( "context" "fmt" "io" iam "google.golang.org/api/iam/v1" ) // listServiceAccounts lists a project's service accounts. func listServiceAccounts(w io.Writer, projectID string) iam.ServiceAccount, error) { ctx := context.Background() service, err := iam.NewService(ctx) if err != nil { return nil, fmt.Errorf("iam.NewService: %v", err) } response, err := service.Projects.ServiceAccounts.List("projects/" + projectID).Do() if err != nil { return nil, fmt.Errorf("Projects.ServiceAccounts.List: %v", err) } for _, account := range response.Accounts { fmt.Fprintf(w, "Listing service account: %v
", account.Name) } return response.Accounts, nil }
Java
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Java API reference documentation
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.iam.v1.Iam; import com.google.api.services.iam.v1.IamScopes; import com.google.api.services.iam.v1.model.ListServiceAccountsResponse; import com.google.api.services.iam.v1.model.ServiceAccount; import com.google.auth.http.HttpCredentialsAdapter; import com.google.auth.oauth2.GoogleCredentials; import java.io.IOException; import java.security.GeneralSecurityException; import java.util.Collections; import java.util.List; public class ListServiceAccounts { // Lists all service accounts for the current project. public static void listServiceAccounts(String projectId) { // String projectId = "my-project-id" Iam service = null; try { service = initService } catch (IOException | GeneralSecurityException e) { System.out.println("Unable to initialize service:
" + e.toString return; } try { ListServiceAccountsResponse response = service.projectsserviceAccountslist("projects/" + projectId).execute List serviceAccounts = response.getAccounts for (ServiceAccount account : serviceAccounts) { System.out.println("Name: " + account.getName System.out.println("Display Name: " + account.getDisplayName System.out.println("Email: " + account.getEmail System.out.println } } catch (IOException e) { System.out.println("Unable to list service accounts:
" + e.toString } } private static Iam initService() throws GeneralSecurityException, IOException { // Use the Application Default Credentials strategy for authentication. For more info, see: // httpscloud.google.com/docs/authentication/production#finding_credentials_automatically GoogleCredentials credential = GoogleCredentials.getApplicationDefault() .createScoped(Collections.singleton(IamScopes.CLOUD_PLATFORM // Initialize the IAM service, which can be used to send requests to the IAM API. Iam service = new Iam.Builder( GoogleNetHttpTransport.newTrustedTransport JacksonFactory.getDefaultInstance new HttpCredentialsAdapter(credential)) .setApplicationName("service-accounts") .build return service; } }
Python
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Python API reference documentation
import os from google.oauth2 import service_account import googleapiclient.discovery def list_service_accounts(project_id): Lists all service accounts for the current project credentials = service_account.Credentials.from_service_account_file( filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS scopeshttpswww.googleapis.com/auth/cloud-platform service = googleapiclient.discovery.build( 'iam', 'v1', credentials=credentials) service_accounts = service.projectsserviceAccountslist( name='projects/' + project_id).execute() for account in service_accounts['accounts print('Name: ' + account['name print('Email: ' + account['email print(' ') return service_accounts
## Updating a service account
The display name (friendly name) and description of a service account are commonly used to capture additional information about the service account, such as the purpose of the service account or a contact person for the account
Console
In the Google Cloud console, go to the
Service accountspage
Select a project
Click the email address of the service account that you want to rename
Enter the new name in the
Namebox, then click Save
gcloud CLI
Execute the
gcloud iam service-accounts update
command to update a service account
Command:
gcloud iam service-accounts update SA_NAME@ PROJECT_ID.iam.gserviceaccount.com \ --description=" UPDATED_SA_DESCRIPTION" \ --display-name=" UPDATED_DISPLAY_NAME"
The output is the renamed service account:
description:
UPDATED_SA_DESCRIPTIONdisplayName: UPDATED_DISPLAY_NAMEname: projects/ PROJECT_ID/serviceAccounts/ SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
REST
The
serviceAccounts.patch
method updates a service account
Before using any of the request data, make the following replacements:
: Your Google Cloud project ID. Project IDs are alphanumeric strings, like
PROJECT_ID
my-project
: The ID of your service account. This can either be the service account's email address in the form
SA_ID
, or the service account's unique numeric ID
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
: The alphanumeric ID of your service account. This name must be between 6 and 30 characters, and can contain lowercase alphanumeric characters and dashes
SA_NAME
- Replace at least one of the following:
: A new display name for your service account
UPDATED_DISPLAY_NAME
: A new description for your service account
UPDATED_DESCRIPTION
HTTP method and URL:
PATCH httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID
Request JSON body:
{ "serviceAccount": { "email": "
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com", "displayName": " UPDATED_DISPLAY_NAME", "description": " UPDATED_DESCRIPTION" }, "updateMask": "displayName,description" }
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Save the request body in a file called
request.json,
and execute the following command:
curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json; charset=utf-8" -d @request.json "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID"
PowerShell (Windows)
Save the request body in a file called
request.json,
and execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID" | Select-Object -Expand Content
API Explorer (browser)
Copy the request body and open the
method reference page
The API Explorer panel opens on the right side of the page
You can interact with this tool to send requests
Paste the request body in this tool, complete any other required fields, and click
**Execute**
You should receive a JSON response similar to the following:
{ "name": "projects/my-project/serviceAccounts/[email protected]", "displayName": "My updated service account", "description": "An updated description of my service account" }
C++
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C++ API reference documentation
namespace iam = ::google::cloud::iam; std::string const& name, std::string const& display_name) { iam::IAMClient client(iam::MakeIAMConnection google::iam::admin::v1::PatchServiceAccountRequest request; google::iam::admin::v1::ServiceAccount service_account; service_account.set_name(name); service_account.set_display_name(display_name); google::protobuf::FieldMask update_mask; *update_mask.add_paths() = "display_name"; *request.mutable_service_account() = service_account; *request.mutable_update_mask() = update_mask; auto response = client.PatchServiceAccount(request); if (!response) throw std::runtime_error(response.statusmessage std::cout << "ServiceAccount successfully updated: " << response->DebugString() << "
"; }
C#
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C# API reference documentation
using System; using Google.Apis.Auth.OAuth2; using Google.Apis.Iam.v1; using Google.Apis.Iam.v1.Data; public partial class ServiceAccounts { public static ServiceAccount RenameServiceAccount(string email, string newDisplayName) { var credential = GoogleCredential.GetApplicationDefault() .CreateScoped(IamService.Scope.CloudPlatform); var service = new IamService(new IamService.Initializer { HttpClientInitializer = credential// First, get a ServiceAccount using List() or Get string resource = "projectsserviceAccounts/" + email; var serviceAccount = service.Projects.ServiceAccounts.Get(resource) .Execute // Then you can update the display name. serviceAccount.DisplayName = newDisplayName; serviceAccount = service.Projects.ServiceAccounts.Update( serviceAccount, resource).Execute Console.WriteLineUpdated display name for {serviceAccount.Email} " + "to: " + serviceAccount.DisplayName); return serviceAccount; } }
Go
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Go API reference documentation
import ( "context" "fmt" "io" iam "google.golang.org/api/iam/v1" ) // renameServiceAccount renames a service account. func renameServiceAccount(w io.Writer, email, newDisplayName string) (*iam.ServiceAccount, error) { ctx := context.Background() service, err := iam.NewService(ctx) if err != nil { return nil, fmt.Errorf("iam.NewService: %v", err) } // First, get a ServiceAccount using List() or Get resource := "projectsserviceAccounts/" + email serviceAccount, err := service.Projects.ServiceAccounts.Get(resource).Do() if err != nil { return nil, fmt.Errorf("Projects.ServiceAccounts.Get: %v", err) } // Then you can update the display name. serviceAccount.DisplayName = newDisplayName serviceAccount, err = service.Projects.ServiceAccounts.Update(resource, serviceAccount).Do() if err != nil { return nil, fmt.Errorf("Projects.ServiceAccounts.Update: %v", err) } fmt.Fprintf(w, "Updated service account: %v", serviceAccount.Email) return serviceAccount, nil }
Java
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Java API reference documentation
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.iam.v1.Iam; import com.google.api.services.iam.v1.IamScopes; import com.google.api.services.iam.v1.model.ServiceAccount; import com.google.auth.http.HttpCredentialsAdapter; import com.google.auth.oauth2.GoogleCredentials; import java.io.IOException; import java.security.GeneralSecurityException; import java.util.Collections; public class RenameServiceAccount { // Changes a service account's display name. public static void renameServiceAccount(String projectId, String serviceAccountName) { // String projectId = "my-project-id"; // String serviceAccountName = "my-service-account-name"; Iam service = null; try { service = initService } catch (IOException | GeneralSecurityException e) { System.out.println("Unable to initialize service:
" + e.toString return; } String serviceAccountEmail = serviceAccountName ++ projectId + ".iam.gserviceaccount.com"; try { // First, get a service account using List() or Get() ServiceAccount serviceAccount = service .projects() .serviceAccounts() .get("projectsserviceAccounts/" + serviceAccountEmail) .execute // Then you can update the display name serviceAccount.setDisplayName("your-new-display-name serviceAccount = service .projects() .serviceAccounts() .update(serviceAccount.getName serviceAccount) .execute System.out.println( "Updated display name for " + serviceAccount.getName() + " to: " + serviceAccount.getDisplayName } catch (IOException e) { System.out.println("Unable to rename service account:
" + e.toString } } private static Iam initService() throws GeneralSecurityException, IOException { // Use the Application Default Credentials strategy for authentication. For more info, see: // httpscloud.google.com/docs/authentication/production#finding_credentials_automatically GoogleCredentials credential = GoogleCredentials.getApplicationDefault() .createScoped(Collections.singleton(IamScopes.CLOUD_PLATFORM // Initialize the IAM service, which can be used to send requests to the IAM API. Iam service = new Iam.Builder( GoogleNetHttpTransport.newTrustedTransport JacksonFactory.getDefaultInstance new HttpCredentialsAdapter(credential)) .setApplicationName("service-accounts") .build return service; } }
Python
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Python API reference documentation
import os from google.oauth2 import service_account import googleapiclient.discovery def rename_service_account(email, new_display_name): Changes a service account's display name # First, get a service account using List() or Get() credentials = service_account.Credentials.from_service_account_file( filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS scopeshttpswww.googleapis.com/auth/cloud-platform service = googleapiclient.discovery.build( 'iam', 'v1', credentials=credentials) resource = 'projectsserviceAccounts/' + email my_service_account = service.projectsserviceAccountsget( name=resource).execute() # Then you can update the display name my_service_account['displayName'] = new_display_name my_service_account = service.projectsserviceAccountsupdate( name=resource, body=my_service_account).execute() print('Updated display name for {} to: format( my_service_account['email my_service_account['displayName return my_service_account
## Disabling a service account
Similar to deleting a service account, when you disable a service account, applications will no longer have access to Google Cloud resources through that service account. If you disable the default App Engine and Compute Engine service accounts, the instances will no longer have access to resources in the project. If you attempt to disable an already disabled service account, it will have no effect
Unlike deleting a service account, disabled service accounts can easily be re-enabled as necessary. We recommend disabling a service account before deleting it to make sure no critical applications are using the service account
Console
In the Google Cloud console, go to the
Service accountspage
Select a project
Click the name of the service account that you want to disable
Under
Service account status, click Disable service account, then click Disableto confirm the change
gcloud CLI
Execute the
gcloud iam service-accounts disable
command to disable a service account
Command:
gcloud iam service-accounts disable
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
Output:
Disabled service account
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
REST
The
serviceAccounts.disable
method immediately disables a service account
Before using any of the request data, make the following replacements:
: Your Google Cloud project ID. Project IDs are alphanumeric strings, like
PROJECT_ID
my-project
: The ID of your service account. This can either be the service account's email address in the form
SA_ID
, or the service account's unique numeric ID
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
HTTP method and URL:
POST httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID:disable
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Execute the following command:
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json; charset=utf-8" -d "" "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID:disable"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID:disable" | Select-Object -Expand Content
API Explorer (browser)
Open the
method reference page
The API Explorer panel opens on the right side of the page
You can interact with this tool to send requests
Complete any required fields and click
**Execute**
If successful, the response body will be empty
C++
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C++ API reference documentation
namespace iam = ::google::cloud::iam; std::string const& name) { iam::IAMClient client(iam::MakeIAMConnection google::iam::admin::v1::DisableServiceAccountRequest request; request.set_name(name); auto response = client.DisableServiceAccount(request); if (!response.ok throw std::runtime_error(response.message std::cout << "ServiceAccount successfully disabled.
"; }
C#
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C# API reference documentation
using System; using Google.Apis.Auth.OAuth2; using Google.Apis.Iam.v1; using Google.Apis.Iam.v1.Data; public partial class ServiceAccounts { public static void DisableServiceAccount(string email) { var credential = GoogleCredential.GetApplicationDefault() .CreateScoped(IamService.Scope.CloudPlatform); var service = new IamService(new IamService.Initializer { HttpClientInitializer = credentialvar request = new DisableServiceAccountRequest string resource = "projectsserviceAccounts/" + email; service.Projects.ServiceAccounts.Disable(request, resource).Execute Console.WriteLine("Disabled service account: " + email); } }
Go
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Go API reference documentation
import ( "context" "fmt" "io" iam "google.golang.org/api/iam/v1" ) // disableServiceAccount disables a service account. func disableServiceAccount(w io.Writer, email string) error { // email:= [email protected] ctx := context.Background() service, err := iam.NewService(ctx) if err != nil { return fmt.Errorf("iam.NewService: %v", err) } request := &iam.DisableServiceAccountRequest{} _, err = service.Projects.ServiceAccounts.Disable("projectsserviceAccountsemail, request).Do() if err != nil { return fmt.Errorf("Projects.ServiceAccounts.Disable: %v", err) } fmt.Fprintf(w, "Disabled service account: %v", email) return nil }
Java
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Java API reference documentation
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.iam.v1.Iam; import com.google.api.services.iam.v1.IamScopes; import com.google.api.services.iam.v1.model.DisableServiceAccountRequest; import com.google.auth.http.HttpCredentialsAdapter; import com.google.auth.oauth2.GoogleCredentials; import java.io.IOException; import java.security.GeneralSecurityException; import java.util.Collections; public class DisableServiceAccount { // Disables a service account. public static void disableServiceAccount(String projectId, String serviceAccountName) { // String projectId = "my-project-id"; // String serviceAccountName = "my-service-account-name"; Iam service = null; try { service = initService } catch (IOException | GeneralSecurityException e) { System.out.println("Unable to initialize service:
" + e.toString return; } String serviceAccountEmail = serviceAccountName ++ projectId + ".iam.gserviceaccount.com"; try { DisableServiceAccountRequest request = new DisableServiceAccountRequest service .projects() .serviceAccounts() .disable("projectsserviceAccounts/" + serviceAccountEmail, request) .execute System.out.println("Disabled service account: " + serviceAccountEmail); } catch (IOException e) { System.out.println("Unable to disable service account:
" + e.toString } } private static Iam initService() throws GeneralSecurityException, IOException { // Use the Application Default Credentials strategy for authentication. For more info, see: // httpscloud.google.com/docs/authentication/production#finding_credentials_automatically GoogleCredentials credential = GoogleCredentials.getApplicationDefault() .createScoped(Collections.singleton(IamScopes.CLOUD_PLATFORM // Initialize the IAM service, which can be used to send requests to the IAM API. Iam service = new Iam.Builder( GoogleNetHttpTransport.newTrustedTransport JacksonFactory.getDefaultInstance new HttpCredentialsAdapter(credential)) .setApplicationName("service-accounts") .build return service; } }
Python
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Python API reference documentation
import os from google.oauth2 import service_account import googleapiclient.discovery def disable_service_account(email): Disables a service account credentials = service_account.Credentials.from_service_account_file( filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS scopeshttpswww.googleapis.com/auth/cloud-platform service = googleapiclient.discovery.build( 'iam', 'v1', credentials=credentials) service.projectsserviceAccountsdisable( name='projectsserviceAccounts/' + email).execute() print("Disabled service account :" + email)
## Enabling a service account
After enabling a disabled service account, applications will regain access to Google Cloud resources through that service account
You can enable a disabled service account whenever you need to. If you attempt to enable an already enabled service account, it will have no effect
Console
In the Google Cloud console, go to the
Service accountspage
Select a project
Click the name of the service account that you want to enable
Under
Service account status, click Enable service account, then click Enableto confirm the change
gcloud CLI
Execute the
gcloud iam service-accounts enable
command to enable a service account
Command:
gcloud iam service-accounts enable
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
Output:
Enabled service account
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
REST
The
serviceAccounts.enable
method enables a previously disabled service account
Before using any of the request data, make the following replacements:
: Your Google Cloud project ID. Project IDs are alphanumeric strings, like
PROJECT_ID
my-project
: The ID of your service account. This can either be the service account's email address in the form
SA_ID
, or the service account's unique numeric ID
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
HTTP method and URL:
POST httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID:enable
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Execute the following command:
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json; charset=utf-8" -d "" "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID:enable"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID:enable" | Select-Object -Expand Content
API Explorer (browser)
Open the
method reference page
The API Explorer panel opens on the right side of the page
You can interact with this tool to send requests
Complete any required fields and click
**Execute**
If successful, the response body will be empty
C++
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C++ API reference documentation
namespace iam = ::google::cloud::iam; std::string const& name) { iam::IAMClient client(iam::MakeIAMConnection google::iam::admin::v1::EnableServiceAccountRequest request; request.set_name(name); auto response = client.EnableServiceAccount(request); if (!response.ok throw std::runtime_error(response.message std::cout << "ServiceAccount successfully enabled.
"; }
C#
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C# API reference documentation
using System; using Google.Apis.Auth.OAuth2; using Google.Apis.Iam.v1; using Google.Apis.Iam.v1.Data; public partial class ServiceAccounts { public static void EnableServiceAccount(string email) { var credential = GoogleCredential.GetApplicationDefault() .CreateScoped(IamService.Scope.CloudPlatform); var service = new IamService(new IamService.Initializer { HttpClientInitializer = credentialvar request = new EnableServiceAccountRequest string resource = "projectsserviceAccounts/" + email; service.Projects.ServiceAccounts.Enable(request, resource).Execute Console.WriteLine("Enabled service account: " + email); } }
Go
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Go API reference documentation
import ( "context" "fmt" "io" iam "google.golang.org/api/iam/v1" ) // enableServiceAccount enables a service account. func enableServiceAccount(w io.Writer, email string) error { // email:= [email protected] ctx := context.Background() service, err := iam.NewService(ctx) if err != nil { return fmt.Errorf("iam.NewService: %v", err) } request := &iam.EnableServiceAccountRequest{} _, err = service.Projects.ServiceAccounts.Enable("projectsserviceAccountsemail, request).Do() if err != nil { return fmt.Errorf("Projects.ServiceAccounts.Enable: %v", err) } fmt.Fprintf(w, "Enabled service account: %v", email) return nil }
Java
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Java API reference documentation
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.iam.v1.Iam; import com.google.api.services.iam.v1.IamScopes; import com.google.api.services.iam.v1.model.EnableServiceAccountRequest; import com.google.auth.http.HttpCredentialsAdapter; import com.google.auth.oauth2.GoogleCredentials; import java.io.IOException; import java.security.GeneralSecurityException; import java.util.Collections; public class EnableServiceAccount { // Enables a service account. public static void enableServiceAccount(String projectId, String serviceAccountName) { // String projectId = "my-project-id"; // String serviceAccountName = "my-service-account-name"; Iam service = null; try { service = initService } catch (IOException | GeneralSecurityException e) { System.out.println("Unable to initialize service:
" + e.toString return; } String serviceAccountEmail = serviceAccountName ++ projectId + ".iam.gserviceaccount.com"; try { EnableServiceAccountRequest request = new EnableServiceAccountRequest service .projects() .serviceAccounts() .enable("projectsserviceAccounts/" + serviceAccountEmail, request) .execute System.out.println("Enabled service account: " + serviceAccountEmail); } catch (IOException e) { System.out.println("Unable to enable service account:
" + e.toString } } private static Iam initService() throws GeneralSecurityException, IOException { // Use the Application Default Credentials strategy for authentication. For more info, see: // httpscloud.google.com/docs/authentication/production#finding_credentials_automatically GoogleCredentials credential = GoogleCredentials.getApplicationDefault() .createScoped(Collections.singleton(IamScopes.CLOUD_PLATFORM // Initialize the IAM service, which can be used to send requests to the IAM API. Iam service = new Iam.Builder( GoogleNetHttpTransport.newTrustedTransport JacksonFactory.getDefaultInstance new HttpCredentialsAdapter(credential)) .setApplicationName("service-accounts") .build return service; } }
Python
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Python API reference documentation
import os from google.oauth2 import service_account import googleapiclient.discovery def enable_service_account(email): Enables a service account credentials = service_account.Credentials.from_service_account_file( filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS scopeshttpswww.googleapis.com/auth/cloud-platform service = googleapiclient.discovery.build( 'iam', 'v1', credentials=credentials) service.projectsserviceAccountsenable( name='projectsserviceAccounts/' + email).execute() print("Enabled service account :" + email)
## Deleting a service account
When you delete a service account, applications will no longer have access to Google Cloud resources through that service account. If you delete the default App Engine and Compute Engine service accounts, the instances will no longer have access to resources in the project
Delete with caution; make sure your critical applications are no longer using a service account before deleting it. If you're not sure whether a service account is being used, we recommend disabling the service account before deleting it. Disabled service accounts can be easily re-enabled if they are still in use
If you delete a service account, then create a new service account with the same name, the new service account is treated as a separate identity; it does not inherit the roles granted to the deleted service account. In contrast, when you delete a service account, then undelete it, the service account's identity does not change, and the service account retains its roles
When a service account is deleted, its role bindings are not immediately
removed; they are automatically purged from the system after a maximum of 60
days. Until that time, the service account appears in role bindings with a
deleted: prefix and a
?uid= suffix, where
`NUMERIC_ID`
is a unique numeric ID for the service
account
`NUMERIC_ID`
Deleted service accounts do not count towards your service account quota
Console
In the Google Cloud console, go to the
Service accountspage
Select a project
Select the service account you want to delete, and then click
Delete
gcloud CLI
Execute the
gcloud iam service-accounts delete
command to delete a service account
Command:
gcloud iam service-accounts delete SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
Output:
Deleted service account
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
REST
The
serviceAccounts.delete
method deletes a service account
Before using any of the request data, make the following replacements:
: Your Google Cloud project ID. Project IDs are alphanumeric strings, like
PROJECT_ID
my-project
: The ID of your service account. This can either be the service account's email address in the form
SA_ID
, or the service account's unique numeric ID
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com
HTTP method and URL:
DELETE httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Execute the following command:
curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_ID" | Select-Object -Expand Content
API Explorer (browser)
Open the
method reference page
The API Explorer panel opens on the right side of the page
You can interact with this tool to send requests
Complete any required fields and click
**Execute**
If successful, the response body will be empty
C++
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C++ API reference documentation
namespace iam = ::google::cloud::iam; std::string const& name) { iam::IAMClient client(iam::MakeIAMConnection auto response = client.DeleteServiceAccount(name); if (!response.ok throw std::runtime_error(response.message std::cout << "ServiceAccount successfully deleted.
"; }
C#
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM C# API reference documentation
using System; using Google.Apis.Auth.OAuth2; using Google.Apis.Iam.v1; public partial class ServiceAccounts { public static void DeleteServiceAccount(string email) { var credential = GoogleCredential.GetApplicationDefault() .CreateScoped(IamService.Scope.CloudPlatform); var service = new IamService(new IamService.Initializer { HttpClientInitializer = credentialstring resource = "projectsserviceAccounts/" + email; service.Projects.ServiceAccounts.Delete(resource).Execute Console.WriteLine("Deleted service account: " + email); } }
Go
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Go API reference documentation
import ( "context" "fmt" "io" iam "google.golang.org/api/iam/v1" ) // deleteServiceAccount deletes a service account. func deleteServiceAccount(w io.Writer, email string) error { ctx := context.Background() service, err := iam.NewService(ctx) if err != nil { return fmt.Errorf("iam.NewService: %v", err) } _, err = service.Projects.ServiceAccounts.Delete("projectsserviceAccounts/" + email).Do() if err != nil { return fmt.Errorf("Projects.ServiceAccounts.Delete: %v", err) } fmt.Fprintf(w, "Deleted service account: %v", email) return nil }
Java
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Java API reference documentation
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.iam.v1.Iam; import com.google.api.services.iam.v1.IamScopes; import com.google.auth.http.HttpCredentialsAdapter; import com.google.auth.oauth2.GoogleCredentials; import java.io.IOException; import java.security.GeneralSecurityException; import java.util.Collections; public class DeleteServiceAccount { // Deletes a service account. public static void deleteServiceAccount(String projectId, String serviceAccountName) { // String projectId = "my-project-id"; // String serviceAccountName = "my-service-account-name"; Iam service = null; try { service = initService } catch (IOException | GeneralSecurityException e) { System.out.println("Unable to initialize service:
" + e.toString return; } String serviceAccountEmail = serviceAccountName ++ projectId + ".iam.gserviceaccount.com"; try { service .projects() .serviceAccounts() .delete("projectsserviceAccounts/" + serviceAccountEmail) .execute System.out.println("Deleted service account: " + serviceAccountEmail); } catch (IOException e) { System.out.println("Unable to delete service account:
" + e.toString } } private static Iam initService() throws GeneralSecurityException, IOException { // Use the Application Default Credentials strategy for authentication. For more info, see: // httpscloud.google.com/docs/authentication/production#finding_credentials_automatically GoogleCredentials credential = GoogleCredentials.getApplicationDefault() .createScoped(Collections.singleton(IamScopes.CLOUD_PLATFORM // Initialize the IAM service, which can be used to send requests to the IAM API. Iam service = new Iam.Builder( GoogleNetHttpTransport.newTrustedTransport JacksonFactory.getDefaultInstance new HttpCredentialsAdapter(credential)) .setApplicationName("service-accounts") .build return service; } }
Python
To learn how to install and use the client library for IAM, see IAM client libraries. For more information, see the IAM Python API reference documentation
import os from google.oauth2 import service_account import googleapiclient.discovery def delete_service_account(email): Deletes a service account credentials = service_account.Credentials.from_service_account_file( filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS scopeshttpswww.googleapis.com/auth/cloud-platform service = googleapiclient.discovery.build( 'iam', 'v1', credentials=credentials) service.projectsserviceAccountsdelete( name='projectsserviceAccounts/' + email).execute() print('Deleted service account: ' + email)
## Undeleting a service account
In some cases, you can use the
undelete command to undelete a deleted service
account. You can usually undelete a deleted service account if it meets these
criteria:
The service account was deleted less than 30 days ago
After 30 days, IAM permanently removes the service account. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request
There is no existing service account with the same name as the deleted service account
For example, suppose that you accidentally delete the service account
[email protected]. You still need a service account with that name, so you create a new service account with the same name,
[email protected]
The new service account does not inherit the permissions of the deleted service account. In effect, it is completely separate from the deleted service account. However, you cannot undelete the original service account, because the new service account has the same name
To address this issue, delete the new service account, then try to undelete the original service account
If you are not able to undelete the service account, you can create a new service account with the same name; revoke all of the roles from the deleted service account; and grant the same roles to the new service account. For details, see Policies with deleted principals
Finding a deleted service account's numeric ID
When you undelete a service account, you must provide its numeric ID. The
numeric ID is a 21-digit number, such as
123456789012345678901, that uniquely
identifies the service account. For example, if you delete a service account,
then create a new service account with the same name, the original service
account and the new service account will have different numeric IDs
If you know that a binding in an allow policy includes the deleted service
account, you can get the allow policy, then find the numeric ID
in the allow policy. The numeric ID is appended to the name of the deleted
service account. For example, in this allow policy, the numeric ID for the
deleted service account is
123456789012345678901:
{ "version": 1, "etag": "BwUjMhCsNvY "bindings": [ { "members": [
"deleted:serviceAccount:[email protected]?uid=123456789012345678901 "role": "roles/iam.serviceAccountUser" }, ] }
Numeric IDs are only appended to the names of deleted principals
Alternatively, you can search your audit logs for the
DeleteServiceAccount
operation that deleted the service account:
In the Google Cloud console, go to the
Logs explorerpage
In the query editor, enter the following query, replacing
with the email address of your service account (for example,
SERVICE_ACCOUNT_EMAIL
[email protected]):
resource.type="service_account" resource.labels.email_id="
SERVICE_ACCOUNT_EMAIL" "DeleteServiceAccount"
If the service account was deleted more than an hour ago, click
Last 1 hour, select a longer period of time from the drop-down list, then click Apply
Click
Run query. The Logs Explorer displays the
DeleteServiceAccountoperations that affected service accounts with the name you specified
Find and note the numeric ID of the deleted service account by doing one of the following:
If the search results include only one
DeleteServiceAccountoperation, find the numeric ID in the
Unique IDfield of the Log fieldspane
If the search results show more than one log, do the following:
Find the correct log entry. To find the correct log entry, click theexpander arrow next to a log entry. Review the details of the log entry and determine whether the log entry shows the operation that you want to undo. Repeat this process until you find the correct log entry
In the correct log entry, locate the service account's numeric ID. To locate the numeric ID, expand the log entry's
protoPayloadfield, then find the
resourceNamefield
The numeric ID is everything after
serviceAccountsin the
resourceNamefield
-
-
Undeleting the service account by numeric ID
After you find the numeric ID for the deleted service account, you can try to undelete the service account
gcloud CLI
Execute the
gcloud beta iam service-accounts undelete
command to undelete a service account
Command:
gcloud beta iam service-accounts undelete
ACCOUNT_ID
Output:
restoredAccount: email:
SA_NAME@ PROJECT_ID.iam.gserviceaccount.com etag: BwWWE7zpApg= name: projects/ PROJECT_ID/serviceAccounts/ SA_NAME@ PROJECT_ID.iam.gserviceaccount.com oauth2ClientId: '123456789012345678901' projectId: PROJECT_IDuniqueId: ' ACCOUNT_ID'
REST
The
serviceAccounts.undelete
method restores a deleted service account
Before using any of the request data, make the following replacements:
: Your Google Cloud project ID. Project IDs are alphanumeric strings, like
PROJECT_ID
my-project
: The unique numeric ID of the service account
SA_NUMERIC_ID
HTTP method and URL:
POST httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_NUMERIC_ID:undelete
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Execute the following command:
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json; charset=utf-8" -d "" "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_NUMERIC_ID:undelete"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "httpsiam.googleapis.com/v1/projects/
PROJECT_ID/serviceAccounts/ SA_NUMERIC_ID:undelete" | Select-Object -Expand Content
API Explorer (browser)
Open the
method reference page
The API Explorer panel opens on the right side of the page
You can interact with this tool to send requests
Complete any required fields and click
**Execute**
If the account can be undeleted, you receive a
200 OK response
code with details about the restored service account, like the following:
{ "restoredAccount": { "name": "projects/my-project/serviceAccounts/[email protected]", "projectId": "my-project", "uniqueId": "123456789012345678901", "email": "[email protected]", "displayName": "My service account", "etag": "BwUp3rVlzes "description": "A service account for running jobs in my project", "oauth2ClientId": "987654321098765432109" } }
## What's next
- Learn how to create and manage service account keys
- Review the process for granting IAM roles to all types of principals, including service accounts
- Explore how you can use role recommendations to downscope permissions for all principals, including service accounts
- Understand how to allow principals to impersonate service accounts
## Try it for yourself
If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.Get started for free
Nube de Google
ALOJAMIENTO WEB COMPARTIDO#49
