Class IdTokenResponse (1.32.1)

public class IdTokenResponse extends TokenResponse

Beta
OAuth ID Connect JSON model for a successful access token response as specified in OpenID Connect Basic Client Profile 1.0 (draft 23).

Implementation is not thread-safe. Sample usage:

static JsonWebSignature executeIdToken(TokenRequest tokenRequest) throws IOException { IdTokenResponse idTokenResponse = IdTokenResponse.execute(tokenRequest); return idTokenResponse.parseIdToken(); }

Inheritance

Object > java.util.AbstractMap > com.google.api.client.util.GenericData > com.google.api.client.json.GenericJson > TokenResponse > IdTokenResponse

Constructors

IdTokenResponse()

public IdTokenResponse()

Methods

clone()

public IdTokenResponse clone()
Returns
TypeDescription
IdTokenResponse
Overrides

execute(TokenRequest tokenRequest)

public static IdTokenResponse execute(TokenRequest tokenRequest)

Executes the given ID token request, and returns the parsed ID token response.

Parameter
NameDescription
tokenRequestTokenRequest

token request

Returns
TypeDescription
IdTokenResponse

parsed successful ID token response

Exceptions
TypeDescription
IOException

for an error response

getIdToken()

public final String getIdToken()

Returns the ID token.

Returns
TypeDescription
String

parseIdToken()

public IdToken parseIdToken()

Parses using JsonWebSignature#parse(JsonFactory, String) based on the JSON factory and ID token.

Returns
TypeDescription
IdToken
Exceptions
TypeDescription
IOException

set(String fieldName, Object value)

public IdTokenResponse set(String fieldName, Object value)
Parameters
NameDescription
fieldNameString
valueObject
Returns
TypeDescription
IdTokenResponse
Overrides

setAccessToken(String accessToken)

public IdTokenResponse setAccessToken(String accessToken)

Sets the access token issued by the authorization server.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
accessTokenString
Returns
TypeDescription
IdTokenResponse
Overrides

setExpiresInSeconds(Long expiresIn)

public IdTokenResponse setExpiresInSeconds(Long expiresIn)

Sets the lifetime in seconds of the access token (for example 3600 for an hour) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
expiresInLong
Returns
TypeDescription
IdTokenResponse
Overrides

setIdToken(String idToken)

public IdTokenResponse setIdToken(String idToken)

Sets the ID token.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
idTokenString
Returns
TypeDescription
IdTokenResponse

setRefreshToken(String refreshToken)

public IdTokenResponse setRefreshToken(String refreshToken)

Sets the refresh token which can be used to obtain new access tokens using the same authorization grant or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
refreshTokenString
Returns
TypeDescription
IdTokenResponse
Overrides

setScope(String scope)

public IdTokenResponse setScope(String scope)

Sets the scope of the access token or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
scopeString
Returns
TypeDescription
IdTokenResponse
Overrides

setTokenType(String tokenType)

public IdTokenResponse setTokenType(String tokenType)

Sets the token type (as specified in Access Token Types).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
tokenTypeString
Returns
TypeDescription
IdTokenResponse
Overrides