Package com.google.auth.oauth2
Interface IdTokenProvider
- All Known Implementing Classes:
ComputeEngineCredentials
,ImpersonatedCredentials
,ServiceAccountCredentials
,UserCredentials
public interface IdTokenProvider
Interface for an Google OIDC token provider. This type represents a google issued OIDC token.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
Enum of various credential-specific options to apply to the token. -
Method Summary
Modifier and TypeMethodDescriptionidTokenWithAudience
(String targetAudience, List<IdTokenProvider.Option> options) Returns a Google OpenID Token with the provided audience field.
-
Method Details
-
idTokenWithAudience
IdToken idTokenWithAudience(String targetAudience, List<IdTokenProvider.Option> options) throws IOException Returns a Google OpenID Token with the provided audience field.- Parameters:
targetAudience
- List of audiences the issued ID Token should be valid for. targetAudience accepts a single string value (multiple audiences are not supported)options
- List of Credential specific options for for the token. For example, an IDToken for a ComputeEngineCredential can return platform specific claims if "ComputeEngineCredentials.ID_TOKEN_FORMAT_FULL" is provided as a list option.- Returns:
- IdToken object which includes the raw id_token, expiration and audience.
- Throws:
IOException
- if token creation fails
-