com.google.api.services.iam.v1

Class Iam.Projects.ServiceAccounts.Keys

java.lang.Object

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

Enclosing class:

Iam.Projects.ServiceAccounts

public class Iam.Projects.ServiceAccounts.Keys
extends Object

The "keys" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Projects.ServiceAccounts.Keys.Create
class	Iam.Projects.ServiceAccounts.Keys.Delete
class	Iam.Projects.ServiceAccounts.Keys.Disable
class	Iam.Projects.ServiceAccounts.Keys.Enable
class	Iam.Projects.ServiceAccounts.Keys.Get
class	Iam.Projects.ServiceAccounts.Keys.List
class	Iam.Projects.ServiceAccounts.Keys.Patch
class	Iam.Projects.ServiceAccounts.Keys.Upload

Constructor Summary

Constructors

Constructor and Description
Keys()

Method Summary

Modifier and Type	Method and Description
Iam.Projects.ServiceAccounts.Keys.Create	create(String name, CreateServiceAccountKeyRequest content) Creates a ServiceAccountKey.
Iam.Projects.ServiceAccounts.Keys.Delete	delete(String name) Deletes a ServiceAccountKey.
Iam.Projects.ServiceAccounts.Keys.Disable	disable(String name, DisableServiceAccountKeyRequest content) Disable a ServiceAccountKey.
Iam.Projects.ServiceAccounts.Keys.Enable	enable(String name, EnableServiceAccountKeyRequest content) Enable a ServiceAccountKey.
Iam.Projects.ServiceAccounts.Keys.Get	get(String name) Gets a ServiceAccountKey.
Iam.Projects.ServiceAccounts.Keys.List	list(String name) Lists every ServiceAccountKey for a service account.
Iam.Projects.ServiceAccounts.Keys.Patch	patch(String name, PatchServiceAccountKeyRequest content) Patches a ServiceAccountKey.
Iam.Projects.ServiceAccounts.Keys.Upload	upload(String name, UploadServiceAccountKeyRequest content) Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount.

Methods inherited from class java.lang.Object

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

Constructor Detail

Keys

public Keys()

Method Detail

create

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

Creates a ServiceAccountKey. Create a request for the method "keys.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 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 CreateServiceAccountKeyRequest

Returns:

the request

Throws:

IOException

delete

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

Deletes a ServiceAccountKey. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key. Create a request for the method "keys.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 key. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_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 key `projects/-/serviceAccounts/fake@example.com/keys/fake-key`, 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.Keys.Disable disable(String name,
                                                         DisableServiceAccountKeyRequest content)
                                                  throws IOException

Disable a ServiceAccountKey. A disabled service account key can be re-enabled with EnableServiceAccountKey. Create a request for the method "keys.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 - Required. The resource name of the service account key. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_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 key `projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the DisableServiceAccountKeyRequest

Returns:

the request

Throws:

IOException

enable

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

Enable a ServiceAccountKey. Create a request for the method "keys.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 - Required. The resource name of the service account key. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_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 key `projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

content - the EnableServiceAccountKeyRequest

Returns:

the request

Throws:

IOException

get

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

Gets a ServiceAccountKey. Create a request for the method "keys.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 key. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` * `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_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 key `projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

Returns:

the request

Throws:

IOException

list

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

Lists every ServiceAccountKey for a service account. Create a request for the method "keys.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 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

patch

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

Patches a ServiceAccountKey. Create a request for the method "keys.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 key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.

content - the PatchServiceAccountKeyRequest

Returns:

the request

Throws:

IOException

upload

public Iam.Projects.ServiceAccounts.Keys.Upload upload(String name,
                                                       UploadServiceAccountKeyRequest content)
                                                throws IOException

Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key. Create a request for the method "keys.upload". 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 key. 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 UploadServiceAccountKeyRequest

Returns:

the request

Throws:

IOException