com.google.auth.oauth2

Class ServiceAccountCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

com.google.auth.oauth2.ServiceAccountCredentials

public class ServiceAccountCredentials
extends GoogleCredentials

OAuth2 credentials representing a Service Account for calling Google APIs.

By default uses a JSON Web Token (JWT) to fetch access tokens.

Constructor Summary

Constructors

Constructor and Description
ServiceAccountCredentials(String clientId, String clientEmail, PrivateKey privateKey, String privateKeyId, Collection<String> scopes) Constructor with minimum identifying information.
ServiceAccountCredentials(String clientId, String clientEmail, PrivateKey privateKey, String privateKeyId, Collection<String> scopes, com.google.api.client.http.HttpTransport transport) Constructor with minimum identifying information and custom HTTP transport.

Method Summary

Modifier and Type	Method and Description
GoogleCredentials	createScoped(Collection<String> newScopes) Clones the service account with the specified scopes.
boolean	createScopedRequired() Returns whther the scopes are empty, meaning createScoped must be called before use.
static ServiceAccountCredentials	fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes) Factory with miniumum identifying information using PKCS#8 for the private key.
static ServiceAccountCredentials	fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes, com.google.api.client.http.HttpTransport transport) Factory with miniumum identifying information and custom transport using PKCS#8 for the private key.
String	getClientEmail()
String	getClientId()
PrivateKey	getPrivateKey()
String	getPrivateKeyId()
Collection<String>	getScopes()
AccessToken	refreshAccessToken() Refreshes the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).

Methods inherited from class com.google.auth.oauth2.GoogleCredentials

fromStream, fromStream, getApplicationDefault, getApplicationDefault

Methods inherited from class com.google.auth.oauth2.OAuth2Credentials

getAuthenticationType, getRequestMetadata, hasRequestMetadata, hasRequestMetadataOnly, refresh

Methods inherited from class com.google.auth.Credentials

getRequestMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceAccountCredentials

public ServiceAccountCredentials(String clientId,
                                 String clientEmail,
                                 PrivateKey privateKey,
                                 String privateKeyId,
                                 Collection<String> scopes)

Constructor with minimum identifying information.

Parameters:

clientId - Client ID of the service account from the console. May be null.

clientEmail - Client email address of the service account from the console.

privateKey - RSA private key object for the service account.

privateKeyId - Private key identifier for the service account. May be null.

scopes - Scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.

ServiceAccountCredentials

public ServiceAccountCredentials(String clientId,
                                 String clientEmail,
                                 PrivateKey privateKey,
                                 String privateKeyId,
                                 Collection<String> scopes,
                                 com.google.api.client.http.HttpTransport transport)

Constructor with minimum identifying information and custom HTTP transport.

Parameters:

clientId - Client ID of the service account from the console. May be null.

clientEmail - Client email address of the service account from the console.

privateKey - RSA private key object for the service account.

privateKeyId - Private key identifier for the service account. May be null.

scopes - Scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.

transport - HTTP object used to get access tokens.

Method Detail

fromPkcs8

public static ServiceAccountCredentials fromPkcs8(String clientId,
                                                  String clientEmail,
                                                  String privateKeyPkcs8,
                                                  String privateKeyId,
                                                  Collection<String> scopes)
                                           throws IOException

Factory with miniumum identifying information using PKCS#8 for the private key.

Parameters:

clientId - Client ID of the service account from the console. May be null.

clientEmail - Client email address of the service account from the console.

privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.

privateKeyId - Private key identifier for the service account. May be null.

scopes - Scope strings for the APIs to be called. May be null or an emptt collection, which results in a credential that must have createScoped called before use.

Throws:

IOException

fromPkcs8

public static ServiceAccountCredentials fromPkcs8(String clientId,
                                                  String clientEmail,
                                                  String privateKeyPkcs8,
                                                  String privateKeyId,
                                                  Collection<String> scopes,
                                                  com.google.api.client.http.HttpTransport transport)
                                           throws IOException

Factory with miniumum identifying information and custom transport using PKCS#8 for the private key.

Parameters:

clientId - Client ID of the service account from the console. May be null.

clientEmail - Client email address of the service account from the console.

privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.

privateKeyId - Private key identifier for the service account. May be null.

scopes - Scope strings for the APIs to be called. May be null or an emptt collection, which results in a credential that must have createScoped called before use.

transport - HTTP object used to get access tokens.

Throws:

IOException

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

Refreshes the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).

Specified by:

refreshAccessToken in class OAuth2Credentials

Throws:

IOException

createScopedRequired

public boolean createScopedRequired()

Returns whther the scopes are empty, meaning createScoped must be called before use.

Overrides:

createScopedRequired in class GoogleCredentials

createScoped

public GoogleCredentials createScoped(Collection<String> newScopes)

Clones the service account with the specified scopes.

Should be called before use for instances with empty scopes.

Overrides:

createScoped in class GoogleCredentials

getClientId

public final String getClientId()

getClientEmail

public final String getClientEmail()

getPrivateKey

public final PrivateKey getPrivateKey()

getPrivateKeyId

public final String getPrivateKeyId()

getScopes

public final Collection<String> getScopes()