Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AccessToken - Class in com.google.auth.oauth2
-
Represents a temporary OAuth2 access token and its expiration information.
- AccessToken(String, Date) - Constructor for class com.google.auth.oauth2.AccessToken
- AccessToken.Builder - Class in com.google.auth.oauth2
- addAvailablePermission(String) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.Builder
-
Adds a permission that can be used on the resource.
- addChangeListener(OAuth2Credentials.CredentialsChangedListener) - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Adds a listener that is notified when the Credentials data changes.
- addRule(CredentialAccessBoundary.AccessBoundaryRule) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.Builder
- ALTS - Enum constant in enum com.google.auth.oauth2.ComputeEngineCredentials.GoogleAuthTransport
- audience - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- AuthHttpConstants - Class in com.google.auth.http
-
Constants used for auth in http
- AuthHttpConstants() - Constructor for class com.google.auth.http.AuthHttpConstants
- AUTHORIZATION - Static variable in class com.google.auth.http.AuthHttpConstants
-
HTTP "Authentication" header
- AWS4 - Enum constant in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
- AwsCredentials - Class in com.google.auth.oauth2
-
Credentials representing an AWS third-party identity for calling Google APIs.
- AwsCredentials.Builder - Class in com.google.auth.oauth2
- AwsCredentialSource - Class in com.google.auth.oauth2
-
The AWS credential source.
- AwsCredentialSource(Map<String, Object>) - Constructor for class com.google.auth.oauth2.AwsCredentialSource
-
The source of the AWS credential.
- AwsSecurityCredentials - Class in com.google.auth.oauth2
-
Defines AWS security credentials.
- AwsSecurityCredentials(String, String, String) - Constructor for class com.google.auth.oauth2.AwsSecurityCredentials
-
Constructor for AWSSecurityCredentials.
- AwsSecurityCredentialsSupplier - Interface in com.google.auth.oauth2
-
Supplier for retrieving AWS Security credentials for
AwsCredentialsto exchange for GCP access tokens.
B
- BEARER - Static variable in class com.google.auth.http.AuthHttpConstants
-
HTTP "Bearer" authentication scheme
- build() - Method in class com.google.auth.oauth2.AccessToken.Builder
- build() - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- build() - Method in class com.google.auth.oauth2.ClientId.Builder
- build() - Method in class com.google.auth.oauth2.CloudShellCredentials.Builder
- build() - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- build() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition.Builder
- build() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.Builder
- build() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.Builder
- build() - Method in class com.google.auth.oauth2.DownscopedCredentials.Builder
- build() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
- build() - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- build() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- build() - Method in class com.google.auth.oauth2.GoogleCredentials.Builder
- build() - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- build() - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
- build() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- build() - Method in class com.google.auth.oauth2.JwtClaims.Builder
- build() - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- build() - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- build() - Method in class com.google.auth.oauth2.OAuth2CredentialsWithRefresh.Builder
- build() - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- build() - Method in class com.google.auth.oauth2.SecureSessionAgent.Builder
- build() - Method in class com.google.auth.oauth2.SecureSessionAgentConfig.Builder
- build() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- build() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- build() - Method in class com.google.auth.oauth2.StsRequestHandler.Builder
- build() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- build() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse.Builder
- build() - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Build the custom TokenVerifier for verifying tokens.
- build() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- build() - Method in class com.google.auth.oauth2.UserCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.AccessToken.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ClientId.Builder
- Builder() - Constructor for class com.google.auth.oauth2.CloudShellCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.GdchCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.GoogleCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.IdTokenCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.JwtClaims.Builder
- Builder() - Constructor for class com.google.auth.oauth2.JwtCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.OAuth2Credentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.SecureSessionAgent.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- Builder() - Constructor for class com.google.auth.oauth2.TokenVerifier.Builder
- Builder() - Constructor for class com.google.auth.oauth2.UserAuthorizer.Builder
- Builder() - Constructor for class com.google.auth.oauth2.UserCredentials.Builder
- Builder(AccessToken) - Constructor for class com.google.auth.oauth2.AccessToken.Builder
- Builder(ClientId) - Constructor for class com.google.auth.oauth2.ClientId.Builder
- Builder(CloudShellCredentials) - Constructor for class com.google.auth.oauth2.CloudShellCredentials.Builder
- Builder(ComputeEngineCredentials) - Constructor for class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- Builder(ExternalAccountAuthorizedUserCredentials) - Constructor for class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
- Builder(ExternalAccountCredentials) - Constructor for class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- Builder(GdchCredentials) - Constructor for class com.google.auth.oauth2.GdchCredentials.Builder
- Builder(GoogleCredentials) - Constructor for class com.google.auth.oauth2.GoogleCredentials.Builder
- Builder(GoogleCredentials.Builder) - Constructor for class com.google.auth.oauth2.GoogleCredentials.Builder
- Builder(GoogleCredentials, String) - Constructor for class com.google.auth.oauth2.ImpersonatedCredentials.Builder
-
Deprecated.
- Builder(ImpersonatedCredentials) - Constructor for class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- Builder(OAuth2Credentials) - Constructor for class com.google.auth.oauth2.OAuth2Credentials.Builder
- Builder(ServiceAccountCredentials) - Constructor for class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- Builder(ServiceAccountJwtAccessCredentials) - Constructor for class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- Builder(UserAuthorizer) - Constructor for class com.google.auth.oauth2.UserAuthorizer.Builder
- Builder(UserCredentials) - Constructor for class com.google.auth.oauth2.UserCredentials.Builder
C
- CertificateIdentityPoolSubjectTokenSupplier - Class in com.google.auth.oauth2
-
Provider for retrieving the subject tokens for
IdentityPoolCredentialsby reading an X.509 certificate from the filesystem. - CertificateSourceUnavailableException - Exception in com.google.auth.mtls
-
This exception is thrown by certificate providers in the Google auth library when the certificate source is unavailable.
- CertificateSourceUnavailableException(String) - Constructor for exception com.google.auth.mtls.CertificateSourceUnavailableException
-
Constructor with a message.
- CertificateSourceUnavailableException(String, Throwable) - Constructor for exception com.google.auth.mtls.CertificateSourceUnavailableException
-
Constructor with a message and throwable cause.
- CertificateSourceUnavailableException(Throwable) - Constructor for exception com.google.auth.mtls.CertificateSourceUnavailableException
-
Constructor with a throwable cause.
- CLIENT_SECRET_BASIC - Enum constant in enum com.google.auth.oauth2.UserAuthorizer.ClientAuthenticationType
- CLIENT_SECRET_POST - Enum constant in enum com.google.auth.oauth2.UserAuthorizer.ClientAuthenticationType
- clientId - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- ClientId - Class in com.google.auth.oauth2
-
An OAuth2 user authorization Client ID and associated information.
- ClientId.Builder - Class in com.google.auth.oauth2
- clientSecret - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- CLOUD_PLATFORM_SCOPE - Static variable in class com.google.auth.oauth2.OAuth2Utils
- CloudShellCredentials - Class in com.google.auth.oauth2
-
OAuth2 credentials representing the built-in service account for Google Cloud Shell.
- CloudShellCredentials.Builder - Class in com.google.auth.oauth2
- com.google.auth.http - package com.google.auth.http
- com.google.auth.mtls - package com.google.auth.mtls
- com.google.auth.oauth2 - package com.google.auth.oauth2
- ComputeEngineCredentials - Class in com.google.auth.oauth2
-
OAuth2 credentials representing the built-in service account for a Google Compute Engine VM.
- ComputeEngineCredentials.BindingEnforcement - Enum in com.google.auth.oauth2
-
Experimental Feature.
- ComputeEngineCredentials.Builder - Class in com.google.auth.oauth2
- ComputeEngineCredentials.GoogleAuthTransport - Enum in com.google.auth.oauth2
-
Experimental Feature.
- ContextAwareMetadataJson - Class in com.google.auth.mtls
-
Data class representing context_aware_metadata.json file.
- ContextAwareMetadataJson() - Constructor for class com.google.auth.mtls.ContextAwareMetadataJson
- create() - Method in interface com.google.auth.http.HttpTransportFactory
-
Creates a
HttpTransportinstance. - create() - Static method in class com.google.auth.mtls.DefaultMtlsProviderFactory
-
Creates an instance of
MtlsProvider. - create() - Method in class com.google.auth.mtls.MtlsHttpTransportFactory
- create() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Create a new ComputeEngineCredentials instance with default behavior.
- create() - Static method in class com.google.auth.oauth2.SecureSessionAgent
- create(int) - Static method in class com.google.auth.oauth2.CloudShellCredentials
- create(AccessToken) - Static method in class com.google.auth.oauth2.GoogleCredentials
-
Returns the credentials instance from the given access token.
- create(AccessToken) - Static method in class com.google.auth.oauth2.OAuth2Credentials
-
Returns the credentials instance from the given access token.
- create(GoogleCredentials, String, List<String>, List<String>, int) - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
- create(GoogleCredentials, String, List<String>, List<String>, int, HttpTransportFactory) - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
- create(GoogleCredentials, String, List<String>, List<String>, int, HttpTransportFactory, String) - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
- create(GoogleCredentials, String, List<String>, List<String>, int, HttpTransportFactory, String, String) - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
- create(String) - Static method in class com.google.auth.oauth2.IdToken
-
Creates an IdToken given the encoded Json Web Signature.
- create(String, JsonFactory) - Static method in class com.google.auth.oauth2.IdToken
-
Creates an IdToken given the encoded Json Web Signature and JSON Factory
- create(String, AccessToken) - Static method in class com.google.auth.oauth2.GoogleCredentials
-
Returns the credentials instance from the given access token and universe domain.
- createBuilder() - Static method in class com.google.auth.oauth2.SecureSessionAgentConfig
- createDelegated(String) - Method in class com.google.auth.oauth2.GoogleCredentials
-
If the credentials support domain-wide delegation, creates a copy of the identity so that it impersonates the specified user; otherwise, returns the same instance.
- createDelegated(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- createScoped(String...) - Method in class com.google.auth.oauth2.GoogleCredentials
-
If the credentials support scopes, creates a copy of the identity with the specified scopes; otherwise, returns the same instance.
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.AwsCredentials
-
Clones the AwsCredentials with the specified scopes.
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Clones the compute engine account with the specified scopes.
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.GoogleCredentials
-
If the credentials support scopes, creates a copy of the identity with the specified scopes, invalidates the existing scoped access token; otherwise, return the same instance.
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.IdentityPoolCredentials
-
Clones the IdentityPoolCredentials with the specified scopes.
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.PluggableAuthCredentials
-
Clones the PluggableAuthCredentials with the specified scopes.
- createScoped(Collection<String>) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Clones the service account with the specified scopes.
- createScoped(Collection<String>, Collection<String>) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Clones the service account with the specified scopes.
- createScoped(Collection<String>, Collection<String>) - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Clones the compute engine account with the specified scopes and default scopes.
- createScoped(Collection<String>, Collection<String>) - Method in class com.google.auth.oauth2.GoogleCredentials
-
If the credentials support scopes, creates a copy of the identity with the specified scopes and default scopes; otherwise, returns the same instance.
- createScopedRequired() - Method in class com.google.auth.oauth2.GoogleCredentials
-
Indicates whether the credentials require scopes to be specified via a call to
GoogleCredentials.createScoped(java.util.Collection<java.lang.String>)before use. - createScopedRequired() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- createScopedRequired() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Returns whether the scopes are empty, meaning createScoped must be called before use.
- createWithCustomCalendar(Calendar) - Method in class com.google.auth.oauth2.ImpersonatedCredentials
-
This method is marked obsolete.
- createWithCustomLifetime(int) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Clones the service account with a new lifetime value.
- createWithCustomRetryStrategy(boolean) - Method in class com.google.auth.oauth2.GoogleCredentials
-
If the credentials support automatic retries, creates a copy of the identity with the provided retry strategy
- createWithCustomRetryStrategy(boolean) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Clones the service account with the specified default retries.
- createWithGdchAudience(String) - Method in class com.google.auth.oauth2.GdchCredentials
-
Create a copy of GDCH credentials with the specified audience.
- createWithGdchAudience(URI) - Method in class com.google.auth.oauth2.GdchCredentials
-
This method is obsolete.
- createWithQuotaProject(String) - Method in class com.google.auth.oauth2.GoogleCredentials
-
Creates a credential with the provided quota project.
- createWithUseJwtAccessWithScope(boolean) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Clones the service account with a new useJwtAccessWithScope value.
- CredentialAccessBoundary - Class in com.google.auth.oauth2
-
Defines an upper bound of permissions available for a GCP credential via
CredentialAccessBoundary.AccessBoundaryRules. - CredentialAccessBoundary.AccessBoundaryRule - Class in com.google.auth.oauth2
-
Defines an upper bound of permissions on a particular resource.
- CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition - Class in com.google.auth.oauth2
-
An optional condition that can be used as part of a
CredentialAccessBoundary.AccessBoundaryRuleto further restrict permissions. - CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition.Builder - Class in com.google.auth.oauth2
- CredentialAccessBoundary.AccessBoundaryRule.Builder - Class in com.google.auth.oauth2
- CredentialAccessBoundary.Builder - Class in com.google.auth.oauth2
- credentialSource - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
D
- DefaultMtlsProviderFactory - Class in com.google.auth.mtls
- DefaultMtlsProviderFactory() - Constructor for class com.google.auth.mtls.DefaultMtlsProviderFactory
- DefaultPKCEProvider - Class in com.google.auth.oauth2
-
Implements PKCE using only the Java standard library.
- DefaultPKCEProvider() - Constructor for class com.google.auth.oauth2.DefaultPKCEProvider
- delete(String) - Method in class com.google.auth.oauth2.MemoryTokensStorage
- delete(String) - Method in interface com.google.auth.oauth2.TokenStore
-
Remove the token data from storage for the given ID.
- DownscopedCredentials - Class in com.google.auth.oauth2
-
DownscopedCredentials enables the ability to downscope, or restrict, the Identity and Access Management (IAM) permissions that a short-lived credential can use for Cloud Storage.
- DownscopedCredentials.Builder - Class in com.google.auth.oauth2
E
- environmentProvider - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- EnvironmentProvider - Interface in com.google.auth.oauth2
-
Interface for an environment provider.
- equals(Object) - Method in class com.google.auth.oauth2.AccessToken
- equals(Object) - Method in class com.google.auth.oauth2.CloudShellCredentials
- equals(Object) - Method in class com.google.auth.oauth2.ComputeEngineCredentials
- equals(Object) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- equals(Object) - Method in class com.google.auth.oauth2.GdchCredentials
- equals(Object) - Method in class com.google.auth.oauth2.GoogleCredentials
- equals(Object) - Method in class com.google.auth.oauth2.IdToken
- equals(Object) - Method in class com.google.auth.oauth2.IdTokenCredentials
- equals(Object) - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- equals(Object) - Method in class com.google.auth.oauth2.JwtCredentials
- equals(Object) - Method in class com.google.auth.oauth2.OAuth2Credentials
- equals(Object) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- equals(Object) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- equals(Object) - Method in class com.google.auth.oauth2.UserCredentials
- exchangeExternalCredentialForAccessToken(StsTokenExchangeRequest) - Method in class com.google.auth.oauth2.ExternalAccountCredentials
-
Exchanges the external credential for a Google Cloud access token.
- exchangeToken() - Method in class com.google.auth.oauth2.StsRequestHandler
-
Exchanges the provided token for another type of token based on the RFC 8693 spec.
- ExternalAccountAuthorizedUserCredentials - Class in com.google.auth.oauth2
-
OAuth2 credentials sourced using external identities through Workforce Identity Federation.
- ExternalAccountAuthorizedUserCredentials.Builder - Class in com.google.auth.oauth2
-
Builder for
ExternalAccountAuthorizedUserCredentials. - ExternalAccountCredentials - Class in com.google.auth.oauth2
-
Base external account credentials class.
- ExternalAccountCredentials(HttpTransportFactory, String, String, String, ExternalAccountCredentials.CredentialSource, String, String, String, String, String, Collection<String>) - Constructor for class com.google.auth.oauth2.ExternalAccountCredentials
-
Constructor with minimum identifying information and custom HTTP transport.
- ExternalAccountCredentials(HttpTransportFactory, String, String, String, ExternalAccountCredentials.CredentialSource, String, String, String, String, String, Collection<String>, EnvironmentProvider) - Constructor for class com.google.auth.oauth2.ExternalAccountCredentials
-
Constructor with minimum identifying information and custom HTTP transport.
- ExternalAccountCredentials(ExternalAccountCredentials.Builder) - Constructor for class com.google.auth.oauth2.ExternalAccountCredentials
-
Internal constructor with minimum identifying information and custom HTTP transport.
- ExternalAccountCredentials.Builder - Class in com.google.auth.oauth2
-
Base builder for external account credentials.
- ExternalAccountCredentials.SubjectTokenTypes - Enum in com.google.auth.oauth2
-
Enum specifying values for the subjectTokenType field in
ExternalAccountCredentials. - ExternalAccountSupplierContext - Class in com.google.auth.oauth2
-
Context object to pass relevant variables from external account credentials to suppliers.
F
- FORMAT_FULL - Enum constant in enum com.google.auth.oauth2.IdTokenProvider.Option
- fromJson(Map<String, Object>) - Static method in class com.google.auth.oauth2.ClientId
-
Constructs a Client ID from JSON from a downloaded file.
- fromPkcs8(String, String, String, String) - Static method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Factory using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, URI) - Static method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Factory using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, Collection<String>) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Factory with minimum identifying information using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, Collection<String>, HttpTransportFactory, URI) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, Collection<String>, HttpTransportFactory, URI, String) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, Collection<String>, Collection<String>) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Factory with minimum identifying information using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, Collection<String>, Collection<String>, HttpTransportFactory, URI) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
- fromPkcs8(String, String, String, String, Collection<String>, Collection<String>, HttpTransportFactory, URI, String) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
- fromResource(Class<?>, String) - Static method in class com.google.auth.oauth2.ClientId
-
Constructs a Client ID from JSON file stored as a resource.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.ClientId
-
Constructs a Client ID from JSON file stream.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
-
Returns external account authorized user credentials defined by a JSON file stream.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.ExternalAccountCredentials
-
Returns credentials defined by a JSON file stream.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.GdchCredentials
-
Returns credentials defined by a GdchCredentials key file in JSON format from the Google Developers Console.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.GoogleCredentials
-
This method is obsolete because of a potential security risk.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Returns credentials defined by a ImpersonatedCredential key file in JSON format from the Google Developers Console.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Returns credentials defined by a Service Account key file in JSON format from the Google Developers Console.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Returns credentials defined by a Service Account key file in JSON format from the Google Developers Console.
- fromStream(InputStream) - Static method in class com.google.auth.oauth2.UserCredentials
-
Returns credentials defined by a JSON file stream using the format supported by the Cloud SDK.
- fromStream(InputStream, URI) - Static method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Returns credentials defined by a Service Account key file in JSON format from the Google Developers Console.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
-
Returns external account authorized user credentials defined by a JSON file stream.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.ExternalAccountCredentials
-
Returns credentials defined by a JSON file stream.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.GdchCredentials
-
Returns credentials defined by a GdchCredentials key file in JSON format from the Google Developers Console.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.GoogleCredentials
-
This method is obsolete because of a potential security risk.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Returns credentials defined by a ImpersonatedCredential key file in JSON format from the Google Developers Console.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Returns credentials defined by a Service Account key file in JSON format from the Google Developers Console.
- fromStream(InputStream, HttpTransportFactory) - Static method in class com.google.auth.oauth2.UserCredentials
-
Returns credentials defined by a JSON file stream using the format supported by the Cloud SDK.
G
- GdchCredentials - Class in com.google.auth.oauth2
- GdchCredentials.Builder - Class in com.google.auth.oauth2
- GET_AUTH_TOKEN_REQUEST - Static variable in class com.google.auth.oauth2.CloudShellCredentials
-
The Cloud Shell back authorization channel uses serialized Javascript Protobuffers, preceded by the message length and a new line character.
- GET_AUTH_TOKEN_REQUEST_BYTES - Static variable in class com.google.auth.oauth2.CloudShellCredentials
- getAccessBoundaryRules() - Method in class com.google.auth.oauth2.CredentialAccessBoundary
- getAccessBoundarySessionKey() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
-
Returns the access boundary session key if present.
- getAccessKeyId() - Method in class com.google.auth.oauth2.AwsSecurityCredentials
-
Gets the AWS access key id.
- getAccessToken() - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- getAccessToken() - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Returns the cached access token.
- getAccessToken() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
- getAccessToken() - Method in class com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
-
Returns the access token obtained from the token exchange.
- getAccount() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Returns the email address associated with the GCE default service account.
- getAccount() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Returns the email field of the serviceAccount that is being impersonated.
- getAccount() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getAccount() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getActingParty() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getAdditionalHeaders() - Method in class com.google.auth.oauth2.GoogleCredentials
- getAdditionalHeaders() - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Provide additional headers to return as request metadata.
- getAndStoreCredentialsFromCode(String, String, URI) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Exchanges an authorization code for tokens and stores them.
- getApiAudience() - Method in class com.google.auth.oauth2.GdchCredentials
-
NOTE: This method is obsolete, please use
GdchCredentials.getGdchAudience()instead. - getApplicationDefault() - Static method in class com.google.auth.oauth2.GoogleCredentials
-
Returns the Application Default Credentials.
- getApplicationDefault(HttpTransportFactory) - Static method in class com.google.auth.oauth2.GoogleCredentials
-
Returns the Application Default Credentials.
- getAudience() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getAudience() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getAudience() - Method in class com.google.auth.oauth2.ExternalAccountSupplierContext
-
Returns the credentials' expected audience.
- getAudience() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getAuthenticationType() - Method in class com.google.auth.oauth2.JwtCredentials
- getAuthenticationType() - Method in class com.google.auth.oauth2.OAuth2Credentials
- getAuthenticationType() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getAuthorizationUrl(String, String, URI) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Return a URL that performs the authorization consent prompt web UI.
- getAuthorizationUrl(String, String, URI, Map<String, String>) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Return a URL that performs the authorization consent prompt web UI.
- getAuthPort() - Method in class com.google.auth.oauth2.CloudShellCredentials.Builder
- getAuthPort() - Method in class com.google.auth.oauth2.CloudShellCredentials
- getAvailabilityCondition() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule
- getAvailablePermissions() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule
- getAvailableResource() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule
- getBindingEnforcement() - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
-
Get the
BindingEnforcementtype. - getCaCertPath() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getCaCertPath() - Method in class com.google.auth.oauth2.GdchCredentials
- getCalendar() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
-
This method is marked obsolete.
- getCallbackUri() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getCallbackUri() - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns the URI for implementation of the OAuth2 web callback.
- getCallbackUri(URI) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns the URI for implementation of the OAuth2 web callback, optionally relative to the specified URI.
- getCertificateConfig() - Method in class com.google.auth.oauth2.IdentityPoolCredentialSource
-
Gets the configuration for X.509-based workload credentials (mTLS), if configured.
- getCertificateConfigLocation() - Method in class com.google.auth.oauth2.IdentityPoolCredentialSource.CertificateConfig
-
Returns the path to the client certificate file, or null if not set.
- getCertificatePath(EnvironmentProvider, PropertyProvider, String) - Static method in class com.google.auth.mtls.MtlsUtils
-
Returns the path to the client certificate file specified by the loaded workload certificate configuration.
- getClientAuthenticationType() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getClientAuthenticationType() - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns the client authentication type as defined in RFC 7591.
- getClientEmail() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getClientEmail() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getClientEmail() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- getClientEmail() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getClientId() - Method in class com.google.auth.oauth2.ClientId
-
Returns the text identifier of the Client ID.
- getClientId() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getClientId() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getClientId() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getClientId() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getClientId() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- getClientId() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getClientId() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getClientId() - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns the Client ID user to identify the OAuth2 consent prompt.
- getClientId() - Method in class com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
-
Returns the OAuth 2.0 client ID used.
- getClientId() - Method in class com.google.auth.oauth2.UserCredentials.Builder
- getClientId() - Method in class com.google.auth.oauth2.UserCredentials
-
Returns client ID of the credential from the console.
- getClientSecret() - Method in class com.google.auth.oauth2.ClientId.Builder
- getClientSecret() - Method in class com.google.auth.oauth2.ClientId
-
Returns the secret associated with the Client ID.
- getClientSecret() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getClientSecret() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getClientSecret() - Method in class com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
-
Returns the OAuth 2.0 client secret used.
- getClientSecret() - Method in class com.google.auth.oauth2.UserCredentials.Builder
- getClientSecret() - Method in class com.google.auth.oauth2.UserCredentials
-
Returns client secret of the credential from the console.
- getCodeChallenge() - Method in class com.google.auth.oauth2.DefaultPKCEProvider
- getCodeChallenge() - Method in interface com.google.auth.oauth2.PKCEProvider
-
Get the code_challenge parameter used in PKCE.
- getCodeChallengeMethod() - Method in class com.google.auth.oauth2.DefaultPKCEProvider
- getCodeChallengeMethod() - Method in interface com.google.auth.oauth2.PKCEProvider
-
Get the code_challenge_method parameter used in PKCE.
- getCodeVerifier() - Method in class com.google.auth.oauth2.DefaultPKCEProvider
- getCodeVerifier() - Method in interface com.google.auth.oauth2.PKCEProvider
-
Get the code_verifier parameter used in PKCE.
- getCommands() - Method in class com.google.auth.mtls.ContextAwareMetadataJson
-
Returns the cert provider command.
- getConfig() - Method in class com.google.auth.oauth2.SecureSessionAgent
-
This method makes a network call to MDS to get the
SecureSessionAgentConfigwhich contains the plaintext and mtls address to reach the S2A (Secure Session Agent). - getCredentialAccessBoundary() - Method in class com.google.auth.oauth2.DownscopedCredentials
- getCredentialInfo() - Method in class com.google.auth.oauth2.GoogleCredentials
-
Provides additional information regarding credential initialization source credential source - Initialized via the GOOGLE_APPLICATION_CREDENTIALS env var or well known file type credential name - The user-friendly name of the credential created principal - Identity used for the credential Unknown field values (i.e. null) are not included in the mapping (e.g.
- getCredentialLocation() - Method in class com.google.auth.oauth2.IdentityPoolCredentialSource
-
Gets the location of the credential source.
- getCredentials() - Method in class com.google.auth.http.HttpCredentialsAdapter
-
A getter for the credentials instance being used
- getCredentials(ExternalAccountSupplierContext) - Method in interface com.google.auth.oauth2.AwsSecurityCredentialsSupplier
-
Gets AWS security credentials.
- getCredentials(String) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Attempts to retrieve credentials for the approved end user consent.
- getCredentialsFromCode(String, URI) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns a UserCredentials instance by exchanging an OAuth2 authorization code for tokens.
- getCredentialsFromCode(String, URI, Map<String, String>) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns a UserCredentials instance by exchanging an OAuth2 authorization code for tokens.
- getCredentialSource() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getDefaultAudience() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- getDefaultScopes() - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- getDefaultScopes() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getDefaultScopes() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getDelegates() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- getDescription() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition
- getEnv(String) - Method in interface com.google.auth.oauth2.EnvironmentProvider
- getEnv(String) - Method in class com.google.auth.oauth2.SystemEnvironmentProvider
- getExpirationMargin() - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- getExpirationTime() - Method in class com.google.auth.oauth2.AccessToken.Builder
- getExpirationTime() - Method in class com.google.auth.oauth2.AccessToken
-
Time when access token will expire.
- getExpiresInSeconds() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
- getExpression() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition
- getFromServiceLoader(Class<? extends T>, T) - Static method in class com.google.auth.oauth2.OAuth2Credentials
-
Returns the first service provider from the given service loader.
- getGdchAudience() - Method in class com.google.auth.oauth2.GdchCredentials
-
Returns the underlying audience string set for this credentials object.
- getGoogleAuthTransport() - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
-
Get the
GoogleAuthTransporttype. - getGrantType() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.SecureSessionAgent.Builder
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
-
Returns the HTTP transport factory used.
- getHttpTransportFactory() - Method in class com.google.auth.oauth2.UserCredentials.Builder
- getIdentityDocumentUrl() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getIdToken() - Method in class com.google.auth.oauth2.IdTokenCredentials
- getIdTokenProvider() - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
- getInstance() - Static method in class com.google.auth.oauth2.SystemEnvironmentProvider
- getInstance() - Static method in class com.google.auth.oauth2.SystemPropertyProvider
- getInternalOptions() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getIssuedTokenType() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
- getJwtClaims() - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- getKeyStore() - Method in interface com.google.auth.mtls.MtlsProvider
-
Returns a mutual TLS key store.
- getKeyStore() - Method in class com.google.auth.mtls.SecureConnectProvider
-
Returns a mutual TLS key store backed by the certificate provided by the SecureConnect tool.
- getKeyStore() - Method in class com.google.auth.mtls.X509Provider
-
Finds the certificate configuration file, then builds a Keystore using the X.509 certificate and private key pointed to by the configuration.
- getLabel() - Method in enum com.google.auth.oauth2.ComputeEngineCredentials.BindingEnforcement
- getLabel() - Method in enum com.google.auth.oauth2.ComputeEngineCredentials.GoogleAuthTransport
- getLifeSpanSeconds() - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- getLifetime() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getLifetime() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- getLifetime() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getMetadataServerUrl() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getMetadataServerUrl(DefaultCredentialsProvider) - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getMetricsCredentialType() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
- getMetricsCredentialType() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- getMetricsCredentialType() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getMetricsCredentialType() - Method in class com.google.auth.oauth2.UserCredentials
- getMtlsAddress() - Method in class com.google.auth.oauth2.SecureSessionAgentConfig
- getOption() - Method in enum com.google.auth.oauth2.IdTokenProvider.Option
- getOptions() - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
- getPKCEProvider() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getPlaintextAddress() - Method in class com.google.auth.oauth2.SecureSessionAgentConfig
- getPrivateKey() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getPrivateKey() - Method in class com.google.auth.oauth2.GdchCredentials
- getPrivateKey() - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- getPrivateKey() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getPrivateKey() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getPrivateKey() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- getPrivateKey() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getPrivateKeyId() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getPrivateKeyId() - Method in class com.google.auth.oauth2.GdchCredentials
- getPrivateKeyId() - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- getPrivateKeyId() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getPrivateKeyId() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getPrivateKeyId() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- getPrivateKeyId() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getProjectId() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Retrieves the Google Cloud project ID from the Compute Engine (GCE) metadata server.
- getProjectId() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getProjectId() - Method in class com.google.auth.oauth2.GdchCredentials
- getProjectId() - Method in class com.google.auth.oauth2.GoogleCredentials
-
The projectId value for a Credential type.
- getProjectId() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getProjectId() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getProjectIdUrl() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getProperty(String, String) - Method in interface com.google.auth.oauth2.PropertyProvider
- getProperty(String, String) - Method in class com.google.auth.oauth2.SystemPropertyProvider
- getQuotaProjectId() - Method in class com.google.auth.oauth2.GoogleCredentials.Builder
- getQuotaProjectId() - Method in class com.google.auth.oauth2.GoogleCredentials
- getQuotaProjectId() - Method in interface com.google.auth.oauth2.QuotaProjectIdProvider
- getQuotaProjectId() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- getQuotaProjectId() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getRefreshHandler() - Method in class com.google.auth.oauth2.OAuth2CredentialsWithRefresh
-
Returns the provided
OAuth2CredentialsWithRefresh.OAuth2RefreshHandler. - getRefreshMargin() - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- getRefreshToken() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getRefreshToken() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
- getRefreshToken() - Method in class com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
-
Returns the refresh token obtained from the token exchange, if available.
- getRefreshToken() - Method in class com.google.auth.oauth2.UserCredentials.Builder
- getRefreshToken() - Method in class com.google.auth.oauth2.UserCredentials
-
Returns the refresh token resulting from a OAuth2 consent flow.
- getRegion(ExternalAccountSupplierContext) - Method in interface com.google.auth.oauth2.AwsSecurityCredentialsSupplier
-
Gets the AWS region to use.
- getRegionalCredentialVerificationUrlOverride() - Method in class com.google.auth.oauth2.AwsCredentials
- getRequestedTokenType() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getRequestMetadata(URI) - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getRequestMetadata(URI) - Method in class com.google.auth.oauth2.JwtCredentials
- getRequestMetadata(URI) - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Provide the request metadata by ensuring there is a current access token and providing it as an authorization bearer token.
- getRequestMetadata(URI) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Provide the request metadata by putting an access JWT directly in the metadata.
- getRequestMetadata(URI) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Provide the request metadata by putting an access JWT directly in the metadata.
- getRequestMetadata(URI, Executor, RequestMetadataCallback) - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getRequestMetadata(URI, Executor, RequestMetadataCallback) - Method in class com.google.auth.oauth2.OAuth2Credentials
- getRequestMetadata(URI, Executor, RequestMetadataCallback) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getRequestMetadata(URI, Executor, RequestMetadataCallback) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- getRequestMetadataInternal() - Method in class com.google.auth.oauth2.OAuth2Credentials
- getResource() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getRevokeUrl() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getScopes() - Method in class com.google.auth.oauth2.AccessToken.Builder
- getScopes() - Method in class com.google.auth.oauth2.AccessToken
-
Scopes from the access token response.
- getScopes() - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- getScopes() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
- getScopes() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getScopes() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- getScopes() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getScopes() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getScopes() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getScopes() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
- getScopes() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getScopes() - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns the scopes defining the user consent.
- getSecretAccessKey() - Method in class com.google.auth.oauth2.AwsSecurityCredentials
-
Gets the AWS secret access key.
- getServiceAccountEmail() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getServiceAccountImpersonationOptions() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getServiceAccountImpersonationUrl() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getServiceAccountsUrl() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getServiceAccountUser() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getServiceAccountUser() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getServiceIdentityName() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getServiceIdentityName() - Method in class com.google.auth.oauth2.GdchCredentials
- getSessionToken() - Method in class com.google.auth.oauth2.AwsSecurityCredentials
-
Gets the AWS session token.
- getSourceCredentials() - Method in class com.google.auth.oauth2.DownscopedCredentials
- getSourceCredentials() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- getSourceCredentials() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- getSubjectToken() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getSubjectToken(ExternalAccountSupplierContext) - Method in class com.google.auth.oauth2.CertificateIdentityPoolSubjectTokenSupplier
-
Retrieves the X509 subject token.
- getSubjectToken(ExternalAccountSupplierContext) - Method in interface com.google.auth.oauth2.IdentityPoolSubjectTokenSupplier
-
Gets a subject token that can be exchanged for a GCP access token.
- getSubjectTokenType() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getSubjectTokenType() - Method in class com.google.auth.oauth2.ExternalAccountSupplierContext
-
Returns the credentials' expected Security Token Service subject token type based on the OAuth 2.0 token exchange spec.
- getSubjectTokenType() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- getTargetAudience() - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
- getTargetPrincipal() - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- getTitle() - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition
- getTokenInfoUrl() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getTokenInfoUrl() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getTokenResponseFromAuthCodeExchange(String, URI, Map<String, String>) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Handles OAuth2 authorization code exchange and returns a
UserAuthorizer.TokenResponseWithConfigobject containing the tokens and configuration details. - getTokenServerEncodedUrl() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getTokenServerEncodedUrl(DefaultCredentialsProvider) - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getTokenServerUri() - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- getTokenServerUri() - Method in class com.google.auth.oauth2.GdchCredentials
- getTokenServerUri() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getTokenServerUri() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getTokenServerUri() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getTokenServerUri() - Method in class com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
-
Returns the URI of the token server used.
- getTokenServerUri() - Method in class com.google.auth.oauth2.UserCredentials.Builder
- getTokenStore() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getTokenStore() - Method in class com.google.auth.oauth2.UserAuthorizer
-
Returns the implementation of a component for long term storage of tokens.
- getTokenType() - Method in class com.google.auth.oauth2.StsTokenExchangeResponse
- getTokenUrl() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- getTokenUrl() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getTokenValue() - Method in class com.google.auth.oauth2.AccessToken.Builder
- getTokenValue() - Method in class com.google.auth.oauth2.AccessToken
-
String representation of the access token.
- getTransportFactory() - Method in class com.google.auth.oauth2.GdchCredentials
- getTrustChainPath() - Method in class com.google.auth.oauth2.IdentityPoolCredentialSource.CertificateConfig
-
Returns the path to the trust chain file, or null if not set.
- getUniverseDomain() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Gets the universe domain from the GCE metadata server.
- getUniverseDomain() - Method in class com.google.auth.oauth2.DownscopedCredentials
-
Returns the universe domain for the credential.
- getUniverseDomain() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- getUniverseDomain() - Method in class com.google.auth.oauth2.GoogleCredentials.Builder
- getUniverseDomain() - Method in class com.google.auth.oauth2.GoogleCredentials
-
Gets the universe domain for the credential.
- getUniverseDomain() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Gets the universe domain for the credential.
- getUniverseDomain() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
-
Returns the universe domain (example, googleapis.com) for the credentials instance.
- getUniverseDomain() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Returns the universe domain (example, googleapis.com) for the credentials instance.
- getUniverseDomainUrl() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- getUseJwtAccessWithScope() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- getUseJwtAccessWithScope() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- getUserAuthUri() - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
- getWellKnownCredentialsPath() - Static method in class com.google.auth.oauth2.GoogleAuthUtils
-
Gets the path to the well-known Application Default Credentials file location
- getWorkforcePoolUserProject() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
- GoogleAuthUtils - Class in com.google.auth.oauth2
-
This public class provides shared utilities for common OAuth2 utils or ADC.
- GoogleAuthUtils() - Constructor for class com.google.auth.oauth2.GoogleAuthUtils
- GoogleCredentials - Class in com.google.auth.oauth2
-
Base type for credentials for authorizing calls to Google APIs using OAuth2.
- GoogleCredentials() - Constructor for class com.google.auth.oauth2.GoogleCredentials
-
Default constructor.
- GoogleCredentials(AccessToken) - Constructor for class com.google.auth.oauth2.GoogleCredentials
-
Deprecated.
- GoogleCredentials(AccessToken, String) - Constructor for class com.google.auth.oauth2.GoogleCredentials
-
Deprecated.
- GoogleCredentials(AccessToken, Duration, Duration) - Constructor for class com.google.auth.oauth2.GoogleCredentials
-
Deprecated.
- GoogleCredentials(GoogleCredentials.Builder) - Constructor for class com.google.auth.oauth2.GoogleCredentials
-
Constructor that relies on a
GoogleCredentials.Builderto provide all the necessary field values for initialization. - GoogleCredentials.Builder - Class in com.google.auth.oauth2
H
- handleResponse(HttpRequest, HttpResponse, boolean) - Method in class com.google.auth.http.HttpCredentialsAdapter
- hasActingParty() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- hasAudience() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- hashCode() - Method in class com.google.auth.oauth2.AccessToken
- hashCode() - Method in class com.google.auth.oauth2.CloudShellCredentials
- hashCode() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
- hashCode() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- hashCode() - Method in class com.google.auth.oauth2.GdchCredentials
- hashCode() - Method in class com.google.auth.oauth2.GoogleCredentials
- hashCode() - Method in class com.google.auth.oauth2.IdToken
- hashCode() - Method in class com.google.auth.oauth2.IdTokenCredentials
- hashCode() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- hashCode() - Method in class com.google.auth.oauth2.JwtCredentials
- hashCode() - Method in class com.google.auth.oauth2.OAuth2Credentials
- hashCode() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- hashCode() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- hashCode() - Method in class com.google.auth.oauth2.UserCredentials
- hasRequestedTokenType() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- hasRequestMetadata() - Method in class com.google.auth.oauth2.JwtCredentials
- hasRequestMetadata() - Method in class com.google.auth.oauth2.OAuth2Credentials
- hasRequestMetadata() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- hasRequestMetadataOnly() - Method in class com.google.auth.oauth2.JwtCredentials
- hasRequestMetadataOnly() - Method in class com.google.auth.oauth2.OAuth2Credentials
- hasRequestMetadataOnly() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- hasResource() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- hasScopes() - Method in class com.google.auth.oauth2.StsTokenExchangeRequest
- HTTP_TRANSPORT_FACTORY - Static variable in class com.google.auth.oauth2.OAuth2Utils
- HttpCredentialsAdapter - Class in com.google.auth.http
-
A wrapper for using Credentials with the Google API Client Libraries for Java with Http.
- HttpCredentialsAdapter(Credentials) - Constructor for class com.google.auth.http.HttpCredentialsAdapter
- HttpTransportFactory - Interface in com.google.auth.http
-
A base interface for all
HttpTransportfactories.
I
- IAM_POLICY - Enum constant in enum com.google.auth.oauth2.ComputeEngineCredentials.BindingEnforcement
- ID_TOKEN - Enum constant in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
- IdentityPoolCredentials - Class in com.google.auth.oauth2
-
Url-sourced, file-sourced, or user provided supplier method-sourced external account credentials.
- IdentityPoolCredentials.Builder - Class in com.google.auth.oauth2
- IdentityPoolCredentialSource - Class in com.google.auth.oauth2
-
The IdentityPool credential source.
- IdentityPoolCredentialSource(Map<String, Object>) - Constructor for class com.google.auth.oauth2.IdentityPoolCredentialSource
-
The source of the 3P credential.
- IdentityPoolCredentialSource.CertificateConfig - Class in com.google.auth.oauth2
-
Represents the configuration options for X.509-based workload credentials (mTLS).
- IdentityPoolSubjectTokenSupplier - Interface in com.google.auth.oauth2
- IdToken - Class in com.google.auth.oauth2
-
Represents a temporary IdToken and its JsonWebSignature object
- IdTokenCredentials - Class in com.google.auth.oauth2
-
IdTokenCredentials provides a Google Issued OpenIdConnect token.
- IdTokenCredentials.Builder - Class in com.google.auth.oauth2
- IdTokenProvider - Interface in com.google.auth.oauth2
-
Interface for an Google OIDC token provider.
- IdTokenProvider.Option - Enum in com.google.auth.oauth2
-
Enum of various credential-specific options to apply to the token.
- idTokenWithAudience(String, List<IdTokenProvider.Option>) - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Returns a Google ID Token from the metadata server on ComputeEngine
- idTokenWithAudience(String, List<IdTokenProvider.Option>) - Method in interface com.google.auth.oauth2.IdTokenProvider
-
Returns a Google OpenID Token with the provided audience field.
- idTokenWithAudience(String, List<IdTokenProvider.Option>) - Method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Returns an IdToken for the current Credential.
- idTokenWithAudience(String, List<IdTokenProvider.Option>) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Returns a Google ID Token from either the OAuth or IAM Endpoint.
- idTokenWithAudience(String, List<IdTokenProvider.Option>) - Method in class com.google.auth.oauth2.UserCredentials
-
Returns a Google ID Token from the refresh token response.
- impersonatedCredentials - Variable in class com.google.auth.oauth2.ExternalAccountCredentials
- ImpersonatedCredentials - Class in com.google.auth.oauth2
-
ImpersonatedCredentials allowing credentials issued to a user or service account to impersonate another.
- ImpersonatedCredentials.Builder - Class in com.google.auth.oauth2
- INCLUDE_EMAIL - Enum constant in enum com.google.auth.oauth2.IdTokenProvider.Option
- initialize(HttpRequest) - Method in class com.google.auth.http.HttpCredentialsAdapter
- INSTANCE - Static variable in class com.google.auth.oauth2.SystemPropertyProvider
- isAvailable() - Method in interface com.google.auth.mtls.MtlsProvider
-
Returns true if the underlying mTLS provider is available.
- isAvailable() - Method in class com.google.auth.mtls.SecureConnectProvider
-
Returns true if the SecureConnect mTLS provider is available.
- isAvailable() - Method in class com.google.auth.mtls.X509Provider
-
Returns true if the X509 mTLS provider is available.
- isComplete() - Method in class com.google.auth.oauth2.JwtClaims
-
Returns whether or not this set of claims is complete.
- isDefaultRetriesEnabled() - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- isExplicitUniverseDomain() - Method in class com.google.auth.oauth2.GoogleCredentials
-
Gets the flag indicating whether universeDomain was explicitly set by the developer.
- isWorkforcePoolConfiguration() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
J
- JWT - Enum constant in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
- JwtClaims - Class in com.google.auth.oauth2
-
Value class representing the set of fields used as the payload of a JWT token.
- JwtClaims() - Constructor for class com.google.auth.oauth2.JwtClaims
- JwtClaims.Builder - Class in com.google.auth.oauth2
- JwtCredentials - Class in com.google.auth.oauth2
-
Credentials class for calling Google APIs using a JWT with custom claims.
- JwtCredentials.Builder - Class in com.google.auth.oauth2
- JwtProvider - Interface in com.google.auth.oauth2
-
Interface for creating custom JWT tokens
- jwtWithClaims(JwtClaims) - Method in class com.google.auth.oauth2.JwtCredentials
-
Returns a copy of these credentials with modified claims.
- jwtWithClaims(JwtClaims) - Method in interface com.google.auth.oauth2.JwtProvider
-
Returns a new JwtCredentials instance with modified claims.
- jwtWithClaims(JwtClaims) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Returns a new JwtCredentials instance with modified claims.
- jwtWithClaims(JwtClaims) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Returns a new JwtCredentials instance with modified claims.
L
- LICENSES_TRUE - Enum constant in enum com.google.auth.oauth2.IdTokenProvider.Option
- load(String) - Method in class com.google.auth.oauth2.MemoryTokensStorage
- load(String) - Method in interface com.google.auth.oauth2.TokenStore
-
Load the token data from storage for the given ID.
M
- MemoryTokensStorage - Class in com.google.auth.oauth2
-
Represents an in-memory storage of tokens.
- MemoryTokensStorage() - Constructor for class com.google.auth.oauth2.MemoryTokensStorage
- merge(JwtClaims) - Method in class com.google.auth.oauth2.JwtClaims
-
Returns a new Claims instance with overridden fields.
- metricsHandler - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- monitorCredentials(String, UserCredentials) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Adds a listen to rewrite the credentials when the tokens are refreshed.
- MTLS - Enum constant in enum com.google.auth.oauth2.ComputeEngineCredentials.GoogleAuthTransport
- MtlsHttpTransportFactory - Class in com.google.auth.mtls
-
An HttpTransportFactory that creates
NetHttpTransportinstances configured for mTLS (mutual TLS) using a specificKeyStorecontaining the client's certificate and private key. - MtlsHttpTransportFactory(KeyStore) - Constructor for class com.google.auth.mtls.MtlsHttpTransportFactory
-
Constructs a factory for mTLS transports.
- MtlsProvider - Interface in com.google.auth.mtls
-
MtlsProvider is used by the Gax library for configuring mutual TLS in the HTTP and GRPC transport layer.
- MtlsUtils - Class in com.google.auth.mtls
-
Utility class for mTLS related operations.
N
- newBuilder() - Static method in class com.google.auth.oauth2.AccessToken
- newBuilder() - Static method in class com.google.auth.oauth2.AwsCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.ClientId
- newBuilder() - Static method in class com.google.auth.oauth2.CloudShellCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.ComputeEngineCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition
- newBuilder() - Static method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule
- newBuilder() - Static method in class com.google.auth.oauth2.CredentialAccessBoundary
- newBuilder() - Static method in class com.google.auth.oauth2.DownscopedCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.GdchCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.GoogleCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.IdentityPoolCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.IdTokenCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.ImpersonatedCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.JwtClaims
- newBuilder() - Static method in class com.google.auth.oauth2.JwtCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.OAuth2Credentials
- newBuilder() - Static method in class com.google.auth.oauth2.OAuth2CredentialsWithRefresh
- newBuilder() - Static method in class com.google.auth.oauth2.PluggableAuthCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.SecureSessionAgent
- newBuilder() - Static method in class com.google.auth.oauth2.ServiceAccountCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- newBuilder() - Static method in class com.google.auth.oauth2.TokenVerifier
- newBuilder() - Static method in class com.google.auth.oauth2.UserAuthorizer
- newBuilder() - Static method in class com.google.auth.oauth2.UserCredentials
- newBuilder(AwsCredentials) - Static method in class com.google.auth.oauth2.AwsCredentials
- newBuilder(IdentityPoolCredentials) - Static method in class com.google.auth.oauth2.IdentityPoolCredentials
- newBuilder(PluggableAuthCredentials) - Static method in class com.google.auth.oauth2.PluggableAuthCredentials
- newBuilder(String, StsTokenExchangeRequest, HttpRequestFactory) - Static method in class com.google.auth.oauth2.StsRequestHandler
-
Returns a new builder for creating an instance of
StsRequestHandler. - newBuilder(String, String) - Static method in class com.google.auth.oauth2.StsTokenExchangeRequest
-
Returns a new
StsTokenExchangeRequest.Builderinstance. - newBuilder(String, String, String) - Static method in class com.google.auth.oauth2.StsTokenExchangeResponse
-
Returns a new
StsTokenExchangeResponse.Builderinstance. - newInstance(String) - Static method in class com.google.auth.oauth2.OAuth2Credentials
-
Best-effort safe mechanism to attempt to instantiate an
HttpTransportFactoryfrom a class name. - NONE - Enum constant in enum com.google.auth.oauth2.UserAuthorizer.ClientAuthenticationType
O
- OAuth2Credentials - Class in com.google.auth.oauth2
-
Base type for Credentials using OAuth2.
- OAuth2Credentials() - Constructor for class com.google.auth.oauth2.OAuth2Credentials
-
Default constructor.
- OAuth2Credentials(AccessToken) - Constructor for class com.google.auth.oauth2.OAuth2Credentials
-
Constructor with explicit access token.
- OAuth2Credentials(AccessToken, Duration, Duration) - Constructor for class com.google.auth.oauth2.OAuth2Credentials
- OAuth2Credentials.Builder - Class in com.google.auth.oauth2
- OAuth2Credentials.CredentialsChangedListener - Interface in com.google.auth.oauth2
-
Listener for changes to credentials.
- OAuth2CredentialsWithRefresh - Class in com.google.auth.oauth2
-
A refreshable alternative to
OAuth2Credentials. - OAuth2CredentialsWithRefresh(AccessToken, OAuth2CredentialsWithRefresh.OAuth2RefreshHandler) - Constructor for class com.google.auth.oauth2.OAuth2CredentialsWithRefresh
- OAuth2CredentialsWithRefresh(OAuth2CredentialsWithRefresh.Builder) - Constructor for class com.google.auth.oauth2.OAuth2CredentialsWithRefresh
- OAuth2CredentialsWithRefresh.Builder - Class in com.google.auth.oauth2
- OAuth2CredentialsWithRefresh.OAuth2RefreshHandler - Interface in com.google.auth.oauth2
-
Interface for the refresh handler.
- OAuth2Utils - Class in com.google.auth.oauth2
-
Internal utilities for the com.google.auth.oauth2 namespace.
- of(String, String) - Static method in class com.google.auth.oauth2.ClientId
-
Constructs a client ID from an explicit ID and secret.
- ON - Enum constant in enum com.google.auth.oauth2.ComputeEngineCredentials.BindingEnforcement
- onChanged(OAuth2Credentials) - Method in interface com.google.auth.oauth2.OAuth2Credentials.CredentialsChangedListener
-
Notifies that the credentials have changed.
P
- PKCEProvider - Interface in com.google.auth.oauth2
- PluggableAuthCredentials - Class in com.google.auth.oauth2
-
PluggableAuthCredentials enables the exchange of workload identity pool external credentials for Google access tokens by retrieving 3rd party tokens through a user supplied executable.
- PluggableAuthCredentials.Builder - Class in com.google.auth.oauth2
- PluggableAuthCredentialSource - Class in com.google.auth.oauth2
-
Encapsulates the credential source portion of the configuration for PluggableAuthCredentials.
- PluggableAuthCredentialSource(Map<String, Object>) - Constructor for class com.google.auth.oauth2.PluggableAuthCredentialSource
- privateKeyFromPkcs8(String) - Static method in class com.google.auth.oauth2.OAuth2Utils
-
Converts a PKCS#8 string to an RSA private key.
- privateKeyFromPkcs8(String, OAuth2Utils.Pkcs8Algorithm) - Static method in class com.google.auth.oauth2.OAuth2Utils
-
Reads a private key from a PKCS#8 encoded string.
- propertyProvider - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- PropertyProvider - Interface in com.google.auth.oauth2
-
Interface for a system property provider.
Q
- quotaProjectId - Variable in class com.google.auth.oauth2.GoogleCredentials.Builder
- quotaProjectId - Variable in class com.google.auth.oauth2.GoogleCredentials
- QuotaProjectIdProvider - Interface in com.google.auth.oauth2
-
Interface for
GoogleCredentialsthat return a quota project ID.
R
- refresh() - Method in class com.google.auth.oauth2.JwtCredentials
-
Refresh the token by discarding the cached token and metadata and rebuilding a new one.
- refresh() - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Request a new token regardless of the current token state.
- refresh() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
-
Discard any cached data
- refreshAccessToken() - Method in class com.google.auth.oauth2.AwsCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.CloudShellCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Refresh the access token by getting it from the GCE metadata server
- refreshAccessToken() - Method in class com.google.auth.oauth2.DownscopedCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.GdchCredentials
-
Refresh the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).
- refreshAccessToken() - Method in class com.google.auth.oauth2.IdentityPoolCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.IdTokenCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Method to refresh the access token according to the specific type of credentials.
- refreshAccessToken() - Method in interface com.google.auth.oauth2.OAuth2CredentialsWithRefresh.OAuth2RefreshHandler
- refreshAccessToken() - Method in class com.google.auth.oauth2.OAuth2CredentialsWithRefresh
-
Refreshes the access token using the provided
OAuth2CredentialsWithRefresh.OAuth2RefreshHandler. - refreshAccessToken() - Method in class com.google.auth.oauth2.PluggableAuthCredentials
- refreshAccessToken() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
-
Refreshes the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).
- refreshAccessToken() - Method in class com.google.auth.oauth2.UserCredentials
-
Refreshes the OAuth2 access token by getting a new access token from the refresh token
- refreshIfExpired() - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Refresh these credentials only if they have expired or are expiring imminently.
- removeChangeListener(OAuth2Credentials.CredentialsChangedListener) - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Removes a listener that was added previously.
- retrieveSubjectToken() - Method in class com.google.auth.oauth2.AwsCredentials
- retrieveSubjectToken() - Method in class com.google.auth.oauth2.ExternalAccountCredentials
-
Retrieves the external subject token to be exchanged for a Google Cloud access token.
- retrieveSubjectToken() - Method in class com.google.auth.oauth2.IdentityPoolCredentials
- retrieveSubjectToken() - Method in class com.google.auth.oauth2.PluggableAuthCredentials
-
Returns the 3rd party subject token by calling the executable specified in the credential source.
- revokeAuthorization(String) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Revokes the authorization for tokens stored for the user.
S
- SAML2 - Enum constant in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
- save(String) - Method in class com.google.auth.oauth2.UserCredentials
-
Saves the end user credentials into the given file path.
- scopes - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- SecureConnectProvider - Class in com.google.auth.mtls
-
This class implements
MtlsProviderfor the Google Auth library transport layer viaContextAwareMetadataJson. - SecureConnectProvider() - Constructor for class com.google.auth.mtls.SecureConnectProvider
- SecureSessionAgent - Class in com.google.auth.oauth2
-
Utilities to fetch the S2A (Secure Session Agent) address from the mTLS configuration.
- SecureSessionAgent.Builder - Class in com.google.auth.oauth2
- SecureSessionAgentConfig - Class in com.google.auth.oauth2
-
Holds an mTLS configuration (consists of address of S2A) retrieved from the Metadata Server.
- SecureSessionAgentConfig.Builder - Class in com.google.auth.oauth2
- ServiceAccountCredentials - Class in com.google.auth.oauth2
-
OAuth2 credentials representing a Service Account for calling Google APIs.
- ServiceAccountCredentials.Builder - Class in com.google.auth.oauth2
- serviceAccountImpersonationOptions - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- serviceAccountImpersonationUrl - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- ServiceAccountJwtAccessCredentials - Class in com.google.auth.oauth2
-
Service Account credentials for calling Google APIs using a JWT directly for access.
- ServiceAccountJwtAccessCredentials.Builder - Class in com.google.auth.oauth2
- setAccessBoundarySessionKey(String) - Method in class com.google.auth.oauth2.StsTokenExchangeResponse.Builder
-
Sets the access boundary session key.
- setAccessToken(AccessToken) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setAccessToken(AccessToken) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the optional access token.
- setAccessToken(AccessToken) - Method in class com.google.auth.oauth2.GoogleCredentials.Builder
- setAccessToken(AccessToken) - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- setAccessToken(AccessToken) - Method in class com.google.auth.oauth2.OAuth2CredentialsWithRefresh.Builder
-
Sets the
AccessTokento be consumed. - setActingParty(ActingParty) - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- setAdditionalClaims(Map<String, String>) - Method in class com.google.auth.oauth2.JwtClaims.Builder
- setAudience(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setAudience(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the optional audience, which is usually the fully specified resource name of the workforce pool provider.
- setAudience(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the Security Token Service audience, which is usually the fully specified resource name of the workload/workforce pool provider.
- setAudience(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setAudience(String) - Method in class com.google.auth.oauth2.JwtClaims.Builder
- setAudience(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setAudience(String) - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- setAudience(String) - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Set a target audience to verify.
- setAuthPort(int) - Method in class com.google.auth.oauth2.CloudShellCredentials.Builder
- setAvailabilityCondition(CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.Builder
-
Sets the availability condition which is an IAM condition that defines constraints to apply to the token expressed in CEL format.
- setAvailablePermissions(List<String>) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.Builder
-
Sets the list of permissions that can be used on the resource.
- setAvailableResource(String) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.Builder
-
Sets the available resource, which is the full resource name of the GCP resource to allow access to.
- setAwsSecurityCredentialsSupplier(AwsSecurityCredentialsSupplier) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
-
Sets the AWS security credentials supplier.
- setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
-
Set the
BindingEnforcementtype. - setCaCertPath(String) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setCalendar(Calendar) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
-
This method is marked obsolete.
- setCallbackUri(URI) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the redirect URI registered with your OAuth provider.
- setCertificatesLocation(String) - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Override the location URL that contains published public keys.
- setClientAuthenticationType(UserAuthorizer.ClientAuthenticationType) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the optional
UserAuthorizer.ClientAuthenticationType, one of the client authentication methods defined in RFC 7591. - setClientEmail(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setClientEmail(String) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setClientId(ClientId) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the OAuth 2.0 client ID.
- setClientId(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setClientId(String) - Method in class com.google.auth.oauth2.ClientId.Builder
- setClientId(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the OAuth 2.0 client ID.
- setClientId(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional client ID of the service account from the console.
- setClientId(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setClientId(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setClientId(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setClientId(String) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setClientId(String) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setClientSecret(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setClientSecret(String) - Method in class com.google.auth.oauth2.ClientId.Builder
- setClientSecret(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the OAuth 2.0 client secret.
- setClientSecret(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional client secret of the service account from the console.
- setClientSecret(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setClientSecret(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setClientSecret(String) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setClock(Clock) - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Set the clock for checking token expiry.
- setCredentialAccessBoundary(CredentialAccessBoundary) - Method in class com.google.auth.oauth2.DownscopedCredentials.Builder
-
Sets the required credential access boundary which specifies the upper bound of permissions that the credential can access.
- setCredentialLocation(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentialSource
-
Sets the location of the credential source.
- setCredentialSource(AwsCredentialSource) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setCredentialSource(ExternalAccountCredentials.CredentialSource) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the external credential source.
- setCredentialSource(IdentityPoolCredentialSource) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setCredentialSource(PluggableAuthCredentialSource) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setDefaultAudience(URI) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setDefaultRetriesEnabled(boolean) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setDefaultScopes(Collection<String>) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- setDelegates(List<String>) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setDescription(String) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition.Builder
-
Sets the description that details the purpose of the condition.
- setExecutableHandler(ExecutableHandler) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setExpirationMargin(Duration) - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- setExpirationMargin(Duration) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setExpirationTime(Date) - Method in class com.google.auth.oauth2.AccessToken.Builder
- setExpiresInSeconds(long) - Method in class com.google.auth.oauth2.StsTokenExchangeResponse.Builder
- setExpression(String) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition.Builder
-
Sets the required expression which must be defined in Common Expression Language (CEL) format.
- setGdchAudience(String) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
-
Sets the intended audience for GDCH credentials.
- setGoogleAuthTransport(ComputeEngineCredentials.GoogleAuthTransport) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
-
Set the
GoogleAuthTransporttype. - setHeaders(HttpHeaders) - Method in class com.google.auth.oauth2.StsRequestHandler.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.DownscopedCredentials.Builder
-
Sets the HTTP transport factory.
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the HTTP transport factory.
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the HTTP transport factory, creates the transport used to get access tokens.
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.SecureSessionAgent.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Set the HttpTransportFactory used for requesting public keys from the certificate URL.
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the HTTP transport factory.
- setHttpTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setIamEndpointOverride(String) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setIdTokenProvider(IdTokenProvider) - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
-
Sets the provider for the ID token.
- setInternalOptions(String) - Method in class com.google.auth.oauth2.StsRequestHandler.Builder
- setInternalOptions(String) - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- setIssuer(String) - Method in class com.google.auth.oauth2.JwtClaims.Builder
- setIssuer(String) - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Set the issuer to verify.
- setJwtClaims(JwtClaims) - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- setLifeSpanSeconds(Long) - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- setLifetime(int) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setLifetime(int) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setMtlsAddress(String) - Method in class com.google.auth.oauth2.SecureSessionAgentConfig.Builder
- setOptions(List<IdTokenProvider.Option>) - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
-
Sets the options for the ID token.
- setPKCEProvider(PKCEProvider) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the optional
PKCEProviderto enable Proof Key for Code Exchange to be used. - setPlaintextAddress(String) - Method in class com.google.auth.oauth2.SecureSessionAgentConfig.Builder
- setPrivateKey(PrivateKey) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setPrivateKey(PrivateKey) - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- setPrivateKey(PrivateKey) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setPrivateKey(PrivateKey) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setPrivateKeyId(String) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setPrivateKeyId(String) - Method in class com.google.auth.oauth2.JwtCredentials.Builder
- setPrivateKeyId(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setPrivateKeyId(String) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setPrivateKeyString(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setProjectId(String) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setProjectId(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setPublicKey(PublicKey) - Method in class com.google.auth.oauth2.TokenVerifier.Builder
-
Set the PublicKey for verifying the signature.
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.CloudShellCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the optional project used for quota and billing purposes.
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional project used for quota and billing purposes.
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.GoogleCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setQuotaProjectId(String) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setRefreshHandler(OAuth2CredentialsWithRefresh.OAuth2RefreshHandler) - Method in class com.google.auth.oauth2.OAuth2CredentialsWithRefresh.Builder
-
Sets the
OAuth2CredentialsWithRefresh.OAuth2RefreshHandlerto be used for token refreshes. - setRefreshMargin(Duration) - Method in class com.google.auth.oauth2.OAuth2Credentials.Builder
- setRefreshMargin(Duration) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setRefreshToken(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the OAuth 2.0 refresh token.
- setRefreshToken(String) - Method in class com.google.auth.oauth2.StsTokenExchangeResponse.Builder
- setRefreshToken(String) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setRegionalCredentialVerificationUrlOverride(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
-
Sets the AWS regional credential verification URL.
- setRequestTokenType(String) - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- setResource(String) - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- setRevokeUrl(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the token revocation endpoint.
- setRules(List<CredentialAccessBoundary.AccessBoundaryRule>) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.Builder
-
Sets the list of
CredentialAccessBoundary.AccessBoundaryRule's. - setScopes(String) - Method in class com.google.auth.oauth2.AccessToken.Builder
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional scopes to request during the authorization grant.
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setScopes(Collection<String>) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the OAuth 2.0 scopes to request.
- setScopes(Collection<String>, Collection<String>) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setScopes(List<String>) - Method in class com.google.auth.oauth2.AccessToken.Builder
- setScopes(List<String>) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
-
Set the scopes to be applied on the impersonated token and not on the source credential.
- setScopes(List<String>) - Method in class com.google.auth.oauth2.StsTokenExchangeRequest.Builder
- setScopes(List<String>) - Method in class com.google.auth.oauth2.StsTokenExchangeResponse.Builder
- setServiceAccountImpersonationOptions(Map<String, Object>) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setServiceAccountImpersonationOptions(Map<String, Object>) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional service account impersonation options.
- setServiceAccountImpersonationOptions(Map<String, Object>) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setServiceAccountImpersonationOptions(Map<String, Object>) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setServiceAccountImpersonationUrl(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setServiceAccountImpersonationUrl(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional URL used for service account impersonation, which is required for some APIs.
- setServiceAccountImpersonationUrl(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setServiceAccountImpersonationUrl(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setServiceAccountUser(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setServiceIdentityName(String) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setSourceCredential(GoogleCredentials) - Method in class com.google.auth.oauth2.DownscopedCredentials.Builder
-
Sets the required source credential used to acquire the downscoped credential.
- setSourceCredentials(GoogleCredentials) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setSubject(String) - Method in class com.google.auth.oauth2.JwtClaims.Builder
- setSubjectTokenSupplier(IdentityPoolSubjectTokenSupplier) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
-
Sets the subject token supplier.
- setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the Security Token Service subject token type based on the OAuth 2.0 token exchange spec.
- setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setSubjectTokenType(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setSubjectTokenType(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the Security Token Service subject token type based on the OAuth 2.0 token exchange spec.
- setSubjectTokenType(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setSubjectTokenType(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setTargetAudience(String) - Method in class com.google.auth.oauth2.IdTokenCredentials.Builder
-
Sets the target audience for the ID token.
- setTargetPrincipal(String) - Method in class com.google.auth.oauth2.ImpersonatedCredentials.Builder
- setTitle(String) - Method in class com.google.auth.oauth2.CredentialAccessBoundary.AccessBoundaryRule.AvailabilityCondition.Builder
-
Sets the optional title that identifies the purpose of the condition.
- setTokenInfoUrl(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setTokenInfoUrl(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the token introspection endpoint used to retrieve account related information.
- setTokenInfoUrl(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional endpoint used to retrieve account related information.
- setTokenInfoUrl(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setTokenInfoUrl(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setTokenServerUri(URI) - Method in class com.google.auth.oauth2.GdchCredentials.Builder
- setTokenServerUri(URI) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setTokenServerUri(URI) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the token exchange endpoint.
- setTokenServerUri(URI) - Method in class com.google.auth.oauth2.UserCredentials.Builder
- setTokenStore(TokenStore) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the
TokenStoreto use for long term token storage. - setTokenUrl(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setTokenUrl(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the token exchange endpoint.
- setTokenUrl(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the Security Token Service token exchange endpoint.
- setTokenUrl(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setTokenUrl(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setTokenValue(String) - Method in class com.google.auth.oauth2.AccessToken.Builder
- setTransportFactory(HttpTransportFactory) - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.ComputeEngineCredentials.Builder
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.DownscopedCredentials.Builder
-
Sets the optional universe domain.
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials.Builder
-
Sets the optional universe domain.
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional universe domain.
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.GoogleCredentials.Builder
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
- setUniverseDomain(String) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials.Builder
- setUseJwtAccessWithScope(boolean) - Method in class com.google.auth.oauth2.ServiceAccountCredentials.Builder
-
Sets the useJwtAccessWithScope flag.
- setUserAuthUri(URI) - Method in class com.google.auth.oauth2.UserAuthorizer.Builder
-
Sets the authorization URI where the user is directed to log in and grant authorization.
- setWorkforcePoolUserProject(String) - Method in class com.google.auth.oauth2.AwsCredentials.Builder
- setWorkforcePoolUserProject(String) - Method in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Sets the optional workforce pool user project number when the credential corresponds to a workforce pool and not a workload identity pool.
- setWorkforcePoolUserProject(String) - Method in class com.google.auth.oauth2.IdentityPoolCredentials.Builder
- setWorkforcePoolUserProject(String) - Method in class com.google.auth.oauth2.PluggableAuthCredentials.Builder
- sign(byte[]) - Method in class com.google.auth.oauth2.ComputeEngineCredentials
-
Signs the provided bytes using the private key associated with the service account.
- sign(byte[]) - Method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Signs the provided bytes using the private key associated with the impersonated service account
- sign(byte[]) - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- sign(byte[]) - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- store(String, String) - Method in class com.google.auth.oauth2.MemoryTokensStorage
- store(String, String) - Method in interface com.google.auth.oauth2.TokenStore
-
Put the token data into storage for the given ID.
- storeCredentials(String, UserCredentials) - Method in class com.google.auth.oauth2.UserAuthorizer
-
Puts the end user credentials in long term storage.
- StsRequestHandler - Class in com.google.auth.oauth2
-
Implements the OAuth 2.0 token exchange based on RFC 8693.
- StsRequestHandler.Builder - Class in com.google.auth.oauth2
- StsTokenExchangeRequest - Class in com.google.auth.oauth2
-
Represents an OAuth 2.0 token exchange request, as defined in RFC 8693, Section 2.1.
- StsTokenExchangeRequest.Builder - Class in com.google.auth.oauth2
- StsTokenExchangeResponse - Class in com.google.auth.oauth2
-
Represents a successful OAuth 2.0 token exchange response from the Google Security Token Service (STS), as defined in RFC 8693, Section 2.2.1.
- StsTokenExchangeResponse.Builder - Class in com.google.auth.oauth2
- subjectTokenType - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- SystemEnvironmentProvider - Class in com.google.auth.oauth2
-
Represents the default system environment provider.
- SystemPropertyProvider - Class in com.google.auth.oauth2
-
Represents the default system property provider.
T
- toBuilder() - Method in class com.google.auth.oauth2.AccessToken
- toBuilder() - Method in class com.google.auth.oauth2.AwsCredentials
- toBuilder() - Method in class com.google.auth.oauth2.ClientId
- toBuilder() - Method in class com.google.auth.oauth2.CloudShellCredentials
- toBuilder() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
- toBuilder() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
- toBuilder() - Method in class com.google.auth.oauth2.GdchCredentials
- toBuilder() - Method in class com.google.auth.oauth2.GoogleCredentials
- toBuilder() - Method in class com.google.auth.oauth2.IdentityPoolCredentials
- toBuilder() - Method in class com.google.auth.oauth2.IdTokenCredentials
- toBuilder() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
- toBuilder() - Method in class com.google.auth.oauth2.OAuth2Credentials
- toBuilder() - Method in class com.google.auth.oauth2.PluggableAuthCredentials
- toBuilder() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- toBuilder() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- toBuilder() - Method in class com.google.auth.oauth2.UserAuthorizer
- toBuilder() - Method in class com.google.auth.oauth2.UserCredentials
- TOKEN_ENDPOINT_RETRYABLE_STATUS_CODES - Static variable in class com.google.auth.oauth2.OAuth2Utils
- TOKEN_EXCHANGE_URL_FORMAT - Static variable in class com.google.auth.oauth2.OAuth2Utils
- TOKEN_TYPE_ACCESS_BOUNDARY_INTERMEDIARY_TOKEN - Static variable in class com.google.auth.oauth2.OAuth2Utils
- TOKEN_TYPE_ACCESS_TOKEN - Static variable in class com.google.auth.oauth2.OAuth2Utils
- tokenInfoUrl - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- TokenStore - Interface in com.google.auth.oauth2
-
Interface for long term storage of tokens
- tokenUrl - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- TokenVerifier - Class in com.google.auth.oauth2
-
Handle verification of Google-signed JWT tokens.
- TokenVerifier.Builder - Class in com.google.auth.oauth2
- TokenVerifier.VerificationException - Exception in com.google.auth.oauth2
-
Custom exception for wrapping all verification errors.
- toString() - Method in class com.google.auth.oauth2.AccessToken
-
Returns a string representation of this access token, including the raw token value.
- toString() - Method in class com.google.auth.oauth2.CloudShellCredentials
- toString() - Method in class com.google.auth.oauth2.ExternalAccountAuthorizedUserCredentials
-
Returns a string representation of this credential.
- toString() - Method in class com.google.auth.oauth2.GdchCredentials
- toString() - Method in class com.google.auth.oauth2.GoogleCredentials
- toString() - Method in class com.google.auth.oauth2.IdToken
- toString() - Method in class com.google.auth.oauth2.IdTokenCredentials
- toString() - Method in class com.google.auth.oauth2.ImpersonatedCredentials
-
Returns a string representation of this credential.
- toString() - Method in class com.google.auth.oauth2.OAuth2Credentials
-
Returns a string representation of this credential, including request metadata and access token.
- toString() - Method in class com.google.auth.oauth2.ServiceAccountJwtAccessCredentials
- toString() - Method in class com.google.auth.oauth2.UserCredentials
-
Returns a string representation of this credential.
- toStringHelper() - Method in class com.google.auth.oauth2.ComputeEngineCredentials
- toStringHelper() - Method in class com.google.auth.oauth2.GoogleCredentials
-
A helper for overriding the toString() method.
- toStringHelper() - Method in class com.google.auth.oauth2.ServiceAccountCredentials
- transportFactory - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
- transportFactory - Variable in class com.google.auth.oauth2.ExternalAccountCredentials
U
- universeDomain - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
-
Deprecated.
- universeDomain - Variable in class com.google.auth.oauth2.GoogleCredentials.Builder
- useDefaultCertificateConfig() - Method in class com.google.auth.oauth2.IdentityPoolCredentialSource.CertificateConfig
-
Returns whether the default certificate configuration should be used.
- UserAuthorizer - Class in com.google.auth.oauth2
-
Handles an interactive 3-Legged-OAuth2 (3LO) user consent authorization.
- UserAuthorizer.Builder - Class in com.google.auth.oauth2
- UserAuthorizer.ClientAuthenticationType - Enum in com.google.auth.oauth2
-
Represents the client authentication types as specified in RFC 7591.
- UserAuthorizer.TokenResponseWithConfig - Class in com.google.auth.oauth2
-
Represents the response from an OAuth token exchange, including configuration details used to initiate the flow.
- UserCredentials - Class in com.google.auth.oauth2
-
OAuth2 Credentials representing a user's identity and consent.
- UserCredentials.Builder - Class in com.google.auth.oauth2
V
- value - Variable in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
- valueOf(String) - Static method in enum com.google.auth.oauth2.ComputeEngineCredentials.BindingEnforcement
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.auth.oauth2.ComputeEngineCredentials.GoogleAuthTransport
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.auth.oauth2.IdTokenProvider.Option
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.auth.oauth2.UserAuthorizer.ClientAuthenticationType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.google.auth.oauth2.ComputeEngineCredentials.BindingEnforcement
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.auth.oauth2.ComputeEngineCredentials.GoogleAuthTransport
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.auth.oauth2.ExternalAccountCredentials.SubjectTokenTypes
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.auth.oauth2.IdTokenProvider.Option
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.auth.oauth2.UserAuthorizer.ClientAuthenticationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VerificationException(String) - Constructor for exception com.google.auth.oauth2.TokenVerifier.VerificationException
- VerificationException(String, Throwable) - Constructor for exception com.google.auth.oauth2.TokenVerifier.VerificationException
- verify(String) - Method in class com.google.auth.oauth2.TokenVerifier
-
Verify an encoded JWT token.
W
- workforcePoolUserProject - Variable in class com.google.auth.oauth2.ExternalAccountCredentials.Builder
X
- X509Provider - Class in com.google.auth.mtls
-
This class implements
MtlsProviderfor the Google Auth library transport layer viaWorkloadCertificateConfiguration. - X509Provider() - Constructor for class com.google.auth.mtls.X509Provider
-
Creates a new X.509 provider that will check the environment variable path and the well known Gcloud certificate configuration location.
- X509Provider(String) - Constructor for class com.google.auth.mtls.X509Provider
-
Creates an X509 provider with an override path for the certificate configuration.
- X509Provider(EnvironmentProvider, PropertyProvider, String) - Constructor for class com.google.auth.mtls.X509Provider
-
Creates an X509 provider with an override path for the certificate configuration, bypassing the normal checks for the well known certificate configuration file path and environment variable.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Builder(ImpersonatedCredentials)instead. This constructor will be removed in a future release.