Package com.google.auth.oauth2

Class JwtCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.JwtCredentials

All Implemented Interfaces:

JwtProvider, Serializable

public class JwtCredentials
extends Credentials
implements JwtProvider

Credentials class for calling Google APIs using a JWT with custom claims.

Uses a JSON Web Token (JWT) directly in the request metadata to provide authorization.

 JwtClaims claims = JwtClaims.newBuilder()
     .setAudience("https://example.com/some-audience")
     .setIssuer("some-issuer@example.com")
     .setSubject("some-subject@example.com")
     .build();
 Credentials = JwtCredentials.newBuilder()
     .setPrivateKey(privateKey)
     .setPrivateKeyId("private-key-id")
     .setJwtClaims(claims)
     .build();
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JwtCredentials.Builder

Field Summary

Fields inherited from class com.google.auth.Credentials

GOOGLE_DEFAULT_UNIVERSE

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAuthenticationType()
Map<String,List<String>>	getRequestMetadata(URI uri)
int	hashCode()
boolean	hasRequestMetadata()
boolean	hasRequestMetadataOnly()
JwtCredentials	jwtWithClaims(JwtClaims newClaims)	Returns a copy of these credentials with modified claims.
static JwtCredentials.Builder	newBuilder()
void	refresh()	Refresh the token by discarding the cached token and metadata and rebuilding a new one.

Methods inherited from class com.google.auth.Credentials

blockingGetToCallback, getMetricsCredentialType, getRequestMetadata, getRequestMetadata, getUniverseDomain

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static JwtCredentials.Builder newBuilder()

refresh

public void refresh()
             throws IOException

Refresh the token by discarding the cached token and metadata and rebuilding a new one.

Specified by:

refresh in class Credentials

Throws:

IOException

jwtWithClaims

public JwtCredentials jwtWithClaims(JwtClaims newClaims)

Returns a copy of these credentials with modified claims.

Specified by:

jwtWithClaims in interface JwtProvider

Parameters:

newClaims - new claims. Any unspecified claim fields default to the current values.

Returns:

new credentials

getAuthenticationType

public String getAuthenticationType()

Specified by:

getAuthenticationType in class Credentials

getRequestMetadata

public Map<String,List<String>> getRequestMetadata(URI uri)
                                            throws IOException

Specified by:

getRequestMetadata in class Credentials

Throws:

IOException

hasRequestMetadata

public boolean hasRequestMetadata()

Specified by:

hasRequestMetadata in class Credentials

hasRequestMetadataOnly

public boolean hasRequestMetadataOnly()

Specified by:

hasRequestMetadataOnly in class Credentials

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object