com.google.api.services.iam.v1.model

Class ServiceAccountKey

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.iam.v1.model.ServiceAccountKey

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ServiceAccountKey
extends GenericJson

Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. We recommend caching the public key set for a service account for no more than 24 hours to ensure you have access to the latest keys. Public keys for all service accounts are also published at the OAuth2 Service Account API.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Identity and Access Management (IAM) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ServiceAccountKey()

Method Summary

Modifier and Type	Method and Description
ServiceAccountKey	clone()
byte[]	decodePrivateKeyData() The private key data.
byte[]	decodePublicKeyData() The public key data.
ServiceAccountKey	encodePrivateKeyData(byte[] privateKeyData) The private key data.
ServiceAccountKey	encodePublicKeyData(byte[] publicKeyData) The public key data.
String	getKeyAlgorithm() Specifies the algorithm (and possibly key size) for the key.
String	getKeyOrigin() The key origin.
String	getName() The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
String	getPrivateKeyData() The private key data.
String	getPrivateKeyType() The output format for the private key.
String	getPublicKeyData() The public key data.
String	getValidAfterTime() The key can be used after this timestamp.
String	getValidBeforeTime() The key can be used before this timestamp.
ServiceAccountKey	set(String fieldName, Object value)
ServiceAccountKey	setKeyAlgorithm(String keyAlgorithm) Specifies the algorithm (and possibly key size) for the key.
ServiceAccountKey	setKeyOrigin(String keyOrigin) The key origin.
ServiceAccountKey	setName(String name) The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
ServiceAccountKey	setPrivateKeyData(String privateKeyData) The private key data.
ServiceAccountKey	setPrivateKeyType(String privateKeyType) The output format for the private key.
ServiceAccountKey	setPublicKeyData(String publicKeyData) The public key data.
ServiceAccountKey	setValidAfterTime(String validAfterTime) The key can be used after this timestamp.
ServiceAccountKey	setValidBeforeTime(String validBeforeTime) The key can be used before this timestamp.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ServiceAccountKey

public ServiceAccountKey()

Method Detail

getKeyAlgorithm

public String getKeyAlgorithm()

Specifies the algorithm (and possibly key size) for the key.

Returns:

value or null for none

setKeyAlgorithm

public ServiceAccountKey setKeyAlgorithm(String keyAlgorithm)

Specifies the algorithm (and possibly key size) for the key.

Parameters:

keyAlgorithm - keyAlgorithm or null for none

getKeyOrigin

public String getKeyOrigin()

The key origin.

Returns:

value or null for none

setKeyOrigin

public ServiceAccountKey setKeyOrigin(String keyOrigin)

The key origin.

Parameters:

keyOrigin - keyOrigin or null for none

getName

public String getName()

The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.

Returns:

value or null for none

setName

public ServiceAccountKey setName(String name)

The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.

Parameters:

name - name or null for none

getPrivateKeyData

public String getPrivateKeyData()

The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.

Returns:

value or null for none

See Also:

decodePrivateKeyData()

decodePrivateKeyData

public byte[] decodePrivateKeyData()

The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPrivateKeyData()

setPrivateKeyData

public ServiceAccountKey setPrivateKeyData(String privateKeyData)

The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.

Parameters:

privateKeyData - privateKeyData or null for none

See Also:

#encodePrivateKeyData()

encodePrivateKeyData

public ServiceAccountKey encodePrivateKeyData(byte[] privateKeyData)

The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getPrivateKeyType

public String getPrivateKeyType()

The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.

Returns:

value or null for none

setPrivateKeyType

public ServiceAccountKey setPrivateKeyType(String privateKeyType)

The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.

Parameters:

privateKeyType - privateKeyType or null for none

getPublicKeyData

public String getPublicKeyData()

The public key data. Only provided in `GetServiceAccountKey` responses.

Returns:

value or null for none

See Also:

decodePublicKeyData()

decodePublicKeyData

public byte[] decodePublicKeyData()

The public key data. Only provided in `GetServiceAccountKey` responses.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPublicKeyData()

setPublicKeyData

public ServiceAccountKey setPublicKeyData(String publicKeyData)

The public key data. Only provided in `GetServiceAccountKey` responses.

Parameters:

publicKeyData - publicKeyData or null for none

See Also:

#encodePublicKeyData()

encodePublicKeyData

public ServiceAccountKey encodePublicKeyData(byte[] publicKeyData)

The public key data. Only provided in `GetServiceAccountKey` responses.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getValidAfterTime

public String getValidAfterTime()

The key can be used after this timestamp.

Returns:

value or null for none

setValidAfterTime

public ServiceAccountKey setValidAfterTime(String validAfterTime)

The key can be used after this timestamp.

Parameters:

validAfterTime - validAfterTime or null for none

getValidBeforeTime

public String getValidBeforeTime()

The key can be used before this timestamp.

Returns:

value or null for none

setValidBeforeTime

public ServiceAccountKey setValidBeforeTime(String validBeforeTime)

The key can be used before this timestamp.

Parameters:

validBeforeTime - validBeforeTime or null for none

set

public ServiceAccountKey set(String fieldName,
                             Object value)

Overrides:

set in class GenericJson

clone

public ServiceAccountKey clone()

Overrides:

clone in class GenericJson