com.google.api.services.iam.v1

Class Iam.Projects.ServiceAccounts

java.lang.Object

com.google.api.services.iam.v1.Iam.Projects.ServiceAccounts

Enclosing class:

Iam.Projects

public class Iam.Projects.ServiceAccounts
extends Object

The "serviceAccounts" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Projects.ServiceAccounts.Create
class	Iam.Projects.ServiceAccounts.Delete
class	Iam.Projects.ServiceAccounts.Disable
class	Iam.Projects.ServiceAccounts.Enable
class	Iam.Projects.ServiceAccounts.Get
class	Iam.Projects.ServiceAccounts.GetIamPolicy
class	Iam.Projects.ServiceAccounts.Keys The "keys" collection of methods.
class	Iam.Projects.ServiceAccounts.List
class	Iam.Projects.ServiceAccounts.Patch
class	Iam.Projects.ServiceAccounts.SetIamPolicy
class	Iam.Projects.ServiceAccounts.SignBlob
class	Iam.Projects.ServiceAccounts.SignJwt
class	Iam.Projects.ServiceAccounts.TestIamPermissions
class	Iam.Projects.ServiceAccounts.Undelete
class	Iam.Projects.ServiceAccounts.Update

Constructor Summary

Constructors

Constructor and Description
ServiceAccounts()

Method Summary

Modifier and Type	Method and Description
Iam.Projects.ServiceAccounts.Create	create(String name, CreateServiceAccountRequest content) Creates a ServiceAccount.
Iam.Projects.ServiceAccounts.Delete	delete(String name) Deletes a ServiceAccount.
Iam.Projects.ServiceAccounts.Disable	disable(String name, DisableServiceAccountRequest content) Disables a ServiceAccount immediately.
Iam.Projects.ServiceAccounts.Enable	enable(String name, EnableServiceAccountRequest content) Enables a ServiceAccount that was disabled by DisableServiceAccount.
Iam.Projects.ServiceAccounts.Get	get(String name) Gets a ServiceAccount.
Iam.Projects.ServiceAccounts.GetIamPolicy	getIamPolicy(String resource) Gets the IAM policy that is attached to a ServiceAccount.
Iam.Projects.ServiceAccounts.Keys	keys() An accessor for creating requests from the Keys collection.
Iam.Projects.ServiceAccounts.List	list(String name) Lists every ServiceAccount that belongs to a specific project.
Iam.Projects.ServiceAccounts.Patch	patch(String name, PatchServiceAccountRequest content) Patches a ServiceAccount.
Iam.Projects.ServiceAccounts.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the IAM policy that is attached to a ServiceAccount.
Iam.Projects.ServiceAccounts.SignBlob	signBlob(String name, SignBlobRequest content) **Note:** This method is deprecated.
Iam.Projects.ServiceAccounts.SignJwt	signJwt(String name, SignJwtRequest content) **Note:** This method is deprecated.
Iam.Projects.ServiceAccounts.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Tests whether the caller has the specified permissions on a ServiceAccount.
Iam.Projects.ServiceAccounts.Undelete	undelete(String name, UndeleteServiceAccountRequest content) Restores a deleted ServiceAccount.
Iam.Projects.ServiceAccounts.Update	update(String name, ServiceAccount content) **Note:** We are in the process of deprecating this method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceAccounts

public ServiceAccounts()

Method Detail

create

public Iam.Projects.ServiceAccounts.Create create(String name,
                                                  CreateServiceAccountRequest content)
                                           throws IOException

Creates a ServiceAccount. Create a request for the method "serviceAccounts.create". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the project associated with the service accounts, such as `projects /my-project-123`.

content - the CreateServiceAccountRequest

Returns:

the request

Throws:

IOException

delete

public Iam.Projects.ServiceAccounts.Delete delete(String name)
                                           throws IOException

Deletes a ServiceAccount. **Warning:** After you delete a service account, you might not be able to undelete it. If you know that you need to re-enable the service account in the future, use DisableServiceAccount instead. If you delete a service account, IAM permanently removes the service account 30 days later. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request. To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use DisableServiceAccount to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account. Create a request for the method "serviceAccounts.delete". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

Returns:

the request

Throws:

IOException

disable

public Iam.Projects.ServiceAccounts.Disable disable(String name,
                                                    DisableServiceAccountRequest content)
                                             throws IOException

Disables a ServiceAccount immediately. If an application uses the service account to authenticate, that application can no longer call Google APIs or access Google Cloud resources. Existing access tokens for the service account are rejected, and requests for new access tokens will fail. To re-enable the service account, use EnableServiceAccount. After you re-enable the service account, its existing access tokens will be accepted, and you can request new access tokens. To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use this method to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account with DeleteServiceAccount. Create a request for the method "serviceAccounts.disable". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the DisableServiceAccountRequest

Returns:

the request

Throws:

IOException

enable

public Iam.Projects.ServiceAccounts.Enable enable(String name,
                                                  EnableServiceAccountRequest content)
                                           throws IOException

Enables a ServiceAccount that was disabled by DisableServiceAccount. If the service account is already enabled, then this method has no effect. If the service account was disabled by other means—for example, if Google disabled the service account because it was compromised—you cannot use this method to enable the service account. Create a request for the method "serviceAccounts.enable". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the EnableServiceAccountRequest

Returns:

the request

Throws:

IOException

get

public Iam.Projects.ServiceAccounts.Get get(String name)
                                     throws IOException

Gets a ServiceAccount. Create a request for the method "serviceAccounts.get". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

Returns:

the request

Throws:

IOException

getIamPolicy

public Iam.Projects.ServiceAccounts.GetIamPolicy getIamPolicy(String resource)
                                                       throws IOException

Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, call the Resource Manager API's [`projects.getIamPolicy`](https://cloud.google.com/resource- manager/reference/rest/v1/projects/getIamPolicy) method. Create a request for the method "serviceAccounts.getIamPolicy". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

public Iam.Projects.ServiceAccounts.List list(String name)
                                       throws IOException

Lists every ServiceAccount that belongs to a specific project. Create a request for the method "serviceAccounts.list". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the project associated with the service accounts, such as `projects /my-project-123`.

Returns:

the request

Throws:

IOException

patch

public Iam.Projects.ServiceAccounts.Patch patch(String name,
                                                PatchServiceAccountRequest content)
                                         throws IOException

Patches a ServiceAccount. Create a request for the method "serviceAccounts.patch". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the PatchServiceAccountRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public Iam.Projects.ServiceAccounts.SetIamPolicy setIamPolicy(String resource,
                                                              SetIamPolicyRequest content)
                                                       throws IOException

Sets the IAM policy that is attached to a ServiceAccount. Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account. This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps: 1. Call the resource's `getIamPolicy` method to get its current IAM policy. 2. Edit the policy so that it binds the service account to an IAM role for the resource. 3. Call the resource's `setIamPolicy` method to update its IAM policy. For detailed instructions, see [Manage access to project, folders, and organizations](https://cloud.google.com/iam/help/service-accounts/granting-access- to-service-accounts) or [Manage access to other resources](https://cloud.google.com/iam/help/access/manage-other-resources). Create a request for the method "serviceAccounts.setIamPolicy". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

signBlob

public Iam.Projects.ServiceAccounts.SignBlob signBlob(String name,
                                                      SignBlobRequest content)
                                               throws IOException

**Note:** This method is deprecated. Use the [`signBlob`](https://cloud.google.com/iam/help/rest- credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount. Create a request for the method "serviceAccounts.signBlob". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the SignBlobRequest

Returns:

the request

Throws:

IOException

signJwt

public Iam.Projects.ServiceAccounts.SignJwt signJwt(String name,
                                                    SignJwtRequest content)
                                             throws IOException

**Note:** This method is deprecated. Use the [`signJwt`](https://cloud.google.com/iam/help/rest- credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. Create a request for the method "serviceAccounts.signJwt". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the SignJwtRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Iam.Projects.ServiceAccounts.TestIamPermissions testIamPermissions(String resource,
                                                                          TestIamPermissionsRequest content)
                                                                   throws IOException

Tests whether the caller has the specified permissions on a ServiceAccount. Create a request for the method "serviceAccounts.testIamPermissions". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

undelete

public Iam.Projects.ServiceAccounts.Undelete undelete(String name,
                                                      UndeleteServiceAccountRequest content)
                                               throws IOException

Restores a deleted ServiceAccount. **Important:** It is not always possible to restore a deleted service account. Use this method only as a last resort. After you delete a service account, IAM permanently removes the service account 30 days later. There is no way to restore a deleted service account that has been permanently removed. Create a request for the method "serviceAccounts.undelete". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the UndeleteServiceAccountRequest

Returns:

the request

Throws:

IOException

update

public Iam.Projects.ServiceAccounts.Update update(String name,
                                                  ServiceAccount content)
                                           throws IOException

**Note:** We are in the process of deprecating this method. Use PatchServiceAccount instead. Updates a ServiceAccount. You can update only the `display_name` field. Create a request for the method "serviceAccounts.update". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the ServiceAccount

Returns:

the request

Throws:

IOException

keys

public Iam.Projects.ServiceAccounts.Keys keys()

An accessor for creating requests from the Keys collection.

The typical use is:

    Iam iam = new Iam(...);
    Iam.Keys.List request = iam.keys().list(parameters ...)
 

Returns:

the resource collection