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 and returns it.
Iam.Projects.ServiceAccounts.Delete	delete(String name) Deletes a ServiceAccount.
Iam.Projects.ServiceAccounts.Disable	disable(String name, DisableServiceAccountRequest content) DisableServiceAccount is currently in the alpha launch stage.
Iam.Projects.ServiceAccounts.Enable	enable(String name, EnableServiceAccountRequest content) EnableServiceAccount is currently in the alpha launch stage.
Iam.Projects.ServiceAccounts.Get	get(String name) Gets a ServiceAccount.
Iam.Projects.ServiceAccounts.GetIamPolicy	getIamPolicy(String resource) Returns the Cloud IAM access control policy for a ServiceAccount.
Iam.Projects.ServiceAccounts.Keys	keys() An accessor for creating requests from the Keys collection.
Iam.Projects.ServiceAccounts.List	list(String name) Lists ServiceAccounts for a project.
Iam.Projects.ServiceAccounts.Patch	patch(String name, PatchServiceAccountRequest content) Patches a ServiceAccount.
Iam.Projects.ServiceAccounts.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the Cloud IAM access control policy for a ServiceAccount.
Iam.Projects.ServiceAccounts.SignBlob	signBlob(String name, SignBlobRequest content) **Note**: This method is in the process of being deprecated.
Iam.Projects.ServiceAccounts.SignJwt	signJwt(String name, SignJwtRequest content) **Note**: This method is in the process of being deprecated.
Iam.Projects.ServiceAccounts.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Tests the specified permissions against the IAM access control policy for 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: This method is in the process of being deprecated.

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 and returns it. 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. 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 - The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

Returns:

the request

Throws:

IOException

disable

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

DisableServiceAccount is currently in the alpha launch stage. Disables a ServiceAccount, which immediately prevents the service account from authenticating and gaining access to APIs. Disabled service accounts can be safely restored by using EnableServiceAccount at any point. Deleted service accounts cannot be restored using this method. Disabling a service account that is bound to VMs, Apps, Functions, or other jobs will cause those jobs to lose access to resources if they are using the disabled service account. To improve reliability of your services and avoid unexpected outages, it is recommended to first disable a service account rather than delete it. After disabling the service account, wait at least 24 hours to verify there are no unintended consequences, and then delete the service account. 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 in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

content - the DisableServiceAccountRequest

Returns:

the request

Throws:

IOException

enable

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

EnableServiceAccount is currently in the alpha launch stage. Restores a disabled ServiceAccount that has been manually disabled by using DisableServiceAccount. Service accounts that have been disabled by other means or for other reasons, such as abuse, cannot be restored using this method. EnableServiceAccount will have no effect on a service account that is not disabled. Enabling an already enabled service account will have no effect. 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 in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

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 - The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

Returns:

the request

Throws:

IOException

getIamPolicy

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

Returns the Cloud IAM access control policy for a ServiceAccount. Note: Service accounts are both [resources and identities](/iam/docs/service- accounts#service_account_permissions). This method treats the service account as a resource. It returns the Cloud IAM policy that reflects what members have access to the service account. This method does not return what resources the service account has access to. To see if a service account has access to a resource, call the `getIamPolicy` method on the target resource. For example, to view grants for a project, call the [projects.getIamPolicy](/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 the operation documentation for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

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

Lists ServiceAccounts for a 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. Currently, only the following fields are updatable: `display_name` and `description`. Only fields specified in the request are guaranteed to be returned in the response. Other fields in the response may be empty. Note: The field mask is required. 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 in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.

content - the PatchServiceAccountRequest

Returns:

the request

Throws:

IOException

setIamPolicy

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

Sets the Cloud IAM access control policy for a ServiceAccount. Note: Service accounts are both [resources and identities](/iam/docs/service- accounts#service_account_permissions). This method treats the service account as a resource. Use it to grant members access to the service account, such as when they need to impersonate it. This method does not grant the service account access to other resources, such as projects. To grant a service account access to resources, include the service account in the Cloud IAM policy for the desired resource, then call the appropriate `setIamPolicy` method on the target resource. For example, to grant a service account access to a project, call the [projects.setIamPolicy ](/resource-manager/reference/rest/v1/projects/setIamPolicy) method. 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 the operation documentation 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 in the process of being deprecated. Call the [`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob) method of the Cloud IAM Service Account Credentials API instead. Signs a blob using a service account's system-managed private key. 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 - The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

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 in the process of being deprecated. Call the [`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt) method of the Cloud IAM Service Account Credentials API instead. Signs a JWT using a service account's system-managed private key. If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an an expiry time of one hour by default. If you request an expiry time of more than one hour, the request will fail. 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 - The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

content - the SignJwtRequest

Returns:

the request

Throws:

IOException

testIamPermissions

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

Tests the specified permissions against the IAM access control policy for 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 the operation documentation 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. This is to be used as an action of last resort. A service account may not always be restorable. 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 in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account.

content - the UndeleteServiceAccountRequest

Returns:

the request

Throws:

IOException

update

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

Note: This method is in the process of being deprecated. Use PatchServiceAccount instead. Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` and `description`. 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 in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.

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