com.google.auth.oauth2

Class IdentityPoolCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

com.google.auth.oauth2.ExternalAccountCredentials

com.google.auth.oauth2.IdentityPoolCredentials

All Implemented Interfaces:

QuotaProjectIdProvider, Serializable

public class IdentityPoolCredentials
extends ExternalAccountCredentials

Url-sourced and file-sourced external account credentials.

By default, attempts to exchange the external credential for a GCP access token.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentityPoolCredentials.Builder

Nested classes/interfaces inherited from class com.google.auth.oauth2.OAuth2Credentials

OAuth2Credentials.CredentialsChangedListener

Field Summary

Fields inherited from class com.google.auth.oauth2.ExternalAccountCredentials

impersonatedCredentials, transportFactory

Method Summary

Modifier and Type	Method and Description
IdentityPoolCredentials	createScoped(Collection<String> newScopes) Clones the IdentityPoolCredentials with the specified scopes.
String	getWorkforcePoolUserProject()
boolean	isWorkforcePoolConfiguration() Returns whether or not the current configuration is for Workforce Pools (which enable 3p user identities, rather than workloads).
static IdentityPoolCredentials.Builder	newBuilder()
static IdentityPoolCredentials.Builder	newBuilder(IdentityPoolCredentials identityPoolCredentials)
AccessToken	refreshAccessToken() Method to refresh the access token according to the specific type of credentials.
String	retrieveSubjectToken() Retrieves the external subject token to be exchanged for a GCP access token.

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

exchangeExternalCredentialForAccessToken, fromStream, fromStream, getAudience, getClientId, getClientSecret, getCredentialSource, getQuotaProjectId, getRequestMetadata, getRequestMetadata, getScopes, getServiceAccountImpersonationUrl, getSubjectTokenType, getTokenInfoUrl, getTokenUrl

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

create, createDelegated, createScoped, createScoped, createScopedRequired, getApplicationDefault, getApplicationDefault, toBuilder

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

addChangeListener, equals, getAccessToken, getAdditionalHeaders, getAuthenticationType, getFromServiceLoader, getRequestMetadataInternal, hashCode, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, refreshIfExpired, removeChangeListener, toString

Methods inherited from class com.google.auth.Credentials

blockingGetToCallback, getRequestMetadata

Methods inherited from class java.lang.Object

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

Method Detail

getWorkforcePoolUserProject

@Nullable
public String getWorkforcePoolUserProject()

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

Description copied from class: OAuth2Credentials

Method to refresh the access token according to the specific type of credentials.

Throws IllegalStateException if not overridden since direct use of OAuth2Credentials is only for temporary or non-refreshing access tokens.

Overrides:

refreshAccessToken in class OAuth2Credentials

Returns:

never

Throws:

IOException

retrieveSubjectToken

public String retrieveSubjectToken()
                            throws IOException

Description copied from class: ExternalAccountCredentials

Retrieves the external subject token to be exchanged for a GCP access token.

Must be implemented by subclasses as the retrieval method is dependent on the credential source.

Specified by:

retrieveSubjectToken in class ExternalAccountCredentials

Returns:

the external subject token

Throws:

IOException

isWorkforcePoolConfiguration

public boolean isWorkforcePoolConfiguration()

Returns whether or not the current configuration is for Workforce Pools (which enable 3p user identities, rather than workloads).

createScoped

public IdentityPoolCredentials createScoped(Collection<String> newScopes)

Clones the IdentityPoolCredentials with the specified scopes.

Overrides:

createScoped in class GoogleCredentials

Parameters:

newScopes - Collection of scopes to request.

Returns:

GoogleCredentials with requested scopes.

newBuilder

public static IdentityPoolCredentials.Builder newBuilder()

newBuilder

public static IdentityPoolCredentials.Builder newBuilder(IdentityPoolCredentials identityPoolCredentials)