Class StsTokenExchangeResponse (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 StsTokenExchangeResponse

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.

This class provides access to the exchanged access token, issued token type, token type, expiration time, refresh token (optional), scopes (optional), and the access boundary session key (optional).

Instances are immutable. Use #newBuilder(String, String, String) to create an instance.

Inheritance

java.lang.Object > StsTokenExchangeResponse

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 accessToken, String issuedTokenType, String tokenType)

public static StsTokenExchangeResponse.Builder newBuilder(String accessToken, String issuedTokenType, String tokenType)

Returns a new StsTokenExchangeResponse.Builder instance.

Parameters
Name	Description
accessToken	String The exchanged access token.
issuedTokenType	String The issued token type. For example, OAuth2Utils#TOKEN_TYPE_ACCESS_TOKEN.
tokenType	String The token type (e.g., "Bearer").

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

Methods

getAccessBoundarySessionKey()

public @Nullable String getAccessBoundarySessionKey()

Returns the access boundary session key if present.

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String	the access boundary session key or null if not present

getAccessToken()

public AccessToken getAccessToken()

Returns
Type	Description
AccessToken

getExpiresInSeconds()

public @Nullable Long getExpiresInSeconds()

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

getIssuedTokenType()

public String getIssuedTokenType()

Returns
Type	Description
String

getRefreshToken()

public @Nullable String getRefreshToken()

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>

getTokenType()

public String getTokenType()

Returns
Type	Description
String