Class StsTokenExchangeRequest (1.50.0)

1.50.0 (latest) 1.49.0 1.48.0 1.46.0 1.43.0 1.42.1 1.41.0 1.40.0 1.39.1 1.38.0 1.37.1 1.36.0 1.35.0 1.34.0 1.33.1 1.32.1 1.31.0 1.30.1 1.29.1-SNAPSHOT 1.28.0 1.27.0 1.26.0 1.25.0 1.24.1 1.20.0 1.19.0 1.18.0 1.7.0 1.6.1 1.4.0 1.3.0

public final class StsTokenExchangeRequest

Represents an OAuth 2.0 token exchange request, as defined in RFC 8693, Section 2.1.

This class encapsulates the parameters necessary for making a token exchange request to Google Security Token Service (STS). It includes the subject token, subject token type, optional parameters like acting party, scopes, resource, audience, requested token type, and internal options.

Instances of this class are immutable. Use the #newBuilder(String, String) method to create a new builder.

Inheritance

java.lang.Object > StsTokenExchangeRequest

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder(String subjectToken, String subjectTokenType)

public static StsTokenExchangeRequest.Builder newBuilder(String subjectToken, String subjectTokenType)

Returns a new StsTokenExchangeRequest.Builder instance.

Parameters
Name	Description
subjectToken	String The token being exchanged. This represents the credentials being used to authorize the token exchange request.
subjectTokenType	String The type of the subjectToken. For example, OAuth2Utils#TOKEN_TYPE_ACCESS_TOKEN.

Returns
Type	Description
StsTokenExchangeRequest.Builder	A new builder for creating StsTokenExchangeRequest instances.

Methods

getActingParty()

public @Nullable ActingParty getActingParty()

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.auth.oauth2.ActingParty

getAudience()

public @Nullable String getAudience()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getGrantType()

public String getGrantType()

Returns
Type	Description
String

getInternalOptions()

public @Nullable String getInternalOptions()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getRequestedTokenType()

public @Nullable String getRequestedTokenType()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getResource()

public @Nullable String getResource()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getScopes()

public @Nullable List<String> getScopes()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.util.List<String>

getSubjectToken()

public String getSubjectToken()

Returns
Type	Description
String

getSubjectTokenType()

public String getSubjectTokenType()

Returns
Type	Description
String

hasActingParty()

public boolean hasActingParty()

Returns
Type	Description
boolean

hasAudience()

public boolean hasAudience()

Returns
Type	Description
boolean

hasRequestedTokenType()

public boolean hasRequestedTokenType()

Returns
Type	Description
boolean

hasResource()

public boolean hasResource()

Returns
Type	Description
boolean

hasScopes()

public boolean hasScopes()

Returns
Type	Description
boolean